Skip to content

Commit

Permalink
[SCSI] bfa: fix comments for header files
Browse files Browse the repository at this point in the history 
This patch addresses the comments from Randy Dunlap (Randy.Dunlap@oracle.com)
regarding comment blocks that begining with "/**". bfa driver comments
currently do not follow kernel-doc convention, we hence replace all
/** with /* and **/ with */.

Signed-off-by: Jing Huang <huangj@brocade.com>
Signed-off-by: James Bottomley <James.Bottomley@suse.de>
  • Loading branch information
Jing Huang authored and James Bottomley committed Oct 25, 2010
1 parent e0a08a3 commit acdc79a
Show file tree
Hide file tree
Showing 16 changed files with 266 additions and 267 deletions.
28 changes: 14 additions & 14 deletions drivers/scsi/bfa/bfa.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ struct bfa_s;
typedef void (*bfa_isr_func_t) (struct bfa_s *bfa, struct bfi_msg_s *m);
typedef void (*bfa_cb_cbfn_t) (void *cbarg, bfa_boolean_t complete);

/**
/*
* Interrupt message handlers
*/
void bfa_isr_unhandled(struct bfa_s *bfa, struct bfi_msg_s *m);
void bfa_isr_bind(enum bfi_mclass mc, bfa_isr_func_t isr_func);

/**
/*
* Request and response queue related defines
*/
#define BFA_REQQ_NELEMS_MIN (4)
Expand All @@ -58,8 +58,8 @@ void bfa_isr_bind(enum bfi_mclass mc, bfa_isr_func_t isr_func);
#define bfa_reqq_produce(__bfa, __reqq) do { \
(__bfa)->iocfc.req_cq_pi[__reqq]++; \
(__bfa)->iocfc.req_cq_pi[__reqq] &= \
((__bfa)->iocfc.cfg.drvcfg.num_reqq_elems - 1); \
writel((__bfa)->iocfc.req_cq_pi[__reqq], \
((__bfa)->iocfc.cfg.drvcfg.num_reqq_elems - 1); \
writel((__bfa)->iocfc.req_cq_pi[__reqq], \
(__bfa)->iocfc.bfa_regs.cpe_q_pi[__reqq]); \
mmiowb(); \
} while (0)
Expand All @@ -76,7 +76,7 @@ void bfa_isr_bind(enum bfi_mclass mc, bfa_isr_func_t isr_func);
(__index) &= ((__size) - 1); \
} while (0)

/**
/*
* Queue element to wait for room in request queue. FIFO order is
* maintained when fullfilling requests.
*/
Expand All @@ -86,7 +86,7 @@ struct bfa_reqq_wait_s {
void *cbarg;
};

/**
/*
* Circular queue usage assignments
*/
enum {
Expand All @@ -113,7 +113,7 @@ bfa_reqq_winit(struct bfa_reqq_wait_s *wqe, void (*qresume) (void *cbarg),

#define bfa_reqq(__bfa, __reqq) (&(__bfa)->reqq_waitq[__reqq])

/**
/*
* static inline void
* bfa_reqq_wait(struct bfa_s *bfa, int reqq, struct bfa_reqq_wait_s *wqe)
*/
Expand All @@ -130,7 +130,7 @@ bfa_reqq_winit(struct bfa_reqq_wait_s *wqe, void (*qresume) (void *cbarg),
#define bfa_reqq_wcancel(__wqe) list_del(&(__wqe)->qe)


/**
/*
* Generic BFA callback element.
*/
struct bfa_cb_qe_s {
Expand Down Expand Up @@ -163,7 +163,7 @@ struct bfa_cb_qe_s {
} while (0)


/**
/*
* PCI devices supported by the current BFA
*/
struct bfa_pciid_s {
Expand All @@ -173,7 +173,7 @@ struct bfa_pciid_s {

extern char bfa_version[];

/**
/*
* BFA memory resources
*/
enum bfa_mem_type {
Expand Down Expand Up @@ -203,7 +203,7 @@ struct bfa_meminfo_s {

struct bfa_iocfc_regs_s {
void __iomem *intr_status;
void __iomem *intr_mask;
void __iomem *intr_mask;
void __iomem *cpe_q_pi[BFI_IOC_MAX_CQS];
void __iomem *cpe_q_ci[BFI_IOC_MAX_CQS];
void __iomem *cpe_q_depth[BFI_IOC_MAX_CQS];
Expand All @@ -214,7 +214,7 @@ struct bfa_iocfc_regs_s {
void __iomem *rme_q_ctrl[BFI_IOC_MAX_CQS];
};

/**
/*
* MSIX vector handlers
*/
#define BFA_MSIX_MAX_VECTORS 22
Expand All @@ -224,7 +224,7 @@ struct bfa_msix_s {
bfa_msix_handler_t handler[BFA_MSIX_MAX_VECTORS];
};

/**
/*
* Chip specific interfaces
*/
struct bfa_hwif_s {
Expand Down Expand Up @@ -343,7 +343,7 @@ int bfa_iocfc_get_pbc_vports(struct bfa_s *bfa,
struct bfi_pbc_vport_s *pbc_vport);


/**
/*
*----------------------------------------------------------------------
* BFA public interfaces
*----------------------------------------------------------------------
Expand Down
20 changes: 10 additions & 10 deletions drivers/scsi/bfa/bfa_cb_ioim.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@ bfad_int_to_lun(u32 luno)
return lun.bfa_lun;
}

/**
/*
* Get LUN for the I/O request
*/
#define bfa_cb_ioim_get_lun(__dio) \
bfad_int_to_lun(((struct scsi_cmnd *)__dio)->device->lun)

/**
/*
* Get CDB for the I/O request
*/
static inline u8 *
Expand All @@ -59,7 +59,7 @@ bfa_cb_ioim_get_cdb(struct bfad_ioim_s *dio)
return (u8 *) cmnd->cmnd;
}

/**
/*
* Get I/O direction (read/write) for the I/O request
*/
static inline enum fcp_iodir
Expand All @@ -77,7 +77,7 @@ bfa_cb_ioim_get_iodir(struct bfad_ioim_s *dio)
return FCP_IODIR_NONE;
}

/**
/*
* Get IO size in bytes for the I/O request
*/
static inline u32
Expand All @@ -88,7 +88,7 @@ bfa_cb_ioim_get_size(struct bfad_ioim_s *dio)
return scsi_bufflen(cmnd);
}

/**
/*
* Get timeout for the I/O request
*/
static inline u8
Expand All @@ -104,7 +104,7 @@ bfa_cb_ioim_get_timeout(struct bfad_ioim_s *dio)
return 0;
}

/**
/*
* Get Command Reference Number for the I/O request. 0 if none.
*/
static inline u8
Expand All @@ -113,7 +113,7 @@ bfa_cb_ioim_get_crn(struct bfad_ioim_s *dio)
return 0;
}

/**
/*
* Get SAM-3 priority for the I/O request. 0 is default.
*/
static inline u8
Expand All @@ -122,7 +122,7 @@ bfa_cb_ioim_get_priority(struct bfad_ioim_s *dio)
return 0;
}

/**
/*
* Get task attributes for the I/O request. Default is FCP_TASK_ATTR_SIMPLE(0).
*/
static inline u8
Expand All @@ -148,7 +148,7 @@ bfa_cb_ioim_get_taskattr(struct bfad_ioim_s *dio)
return task_attr;
}

/**
/*
* Get CDB length in bytes for the I/O request. Default is FCP_CMND_CDB_LEN(16).
*/
static inline u8
Expand All @@ -159,7 +159,7 @@ bfa_cb_ioim_get_cdblen(struct bfad_ioim_s *dio)
return cmnd->cmd_len;
}

/**
/*
* Assign queue to be used for the I/O request. This value depends on whether
* the driver wants to use the queues via any specific algorithm. Currently,
* this is not supported.
Expand Down
24 changes: 12 additions & 12 deletions drivers/scsi/bfa/bfa_cs.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* General Public License for more details.
*/

/**
/*
* bfa_cs.h BFA common services
*/

Expand All @@ -24,7 +24,7 @@

#include "bfa_os_inc.h"

/**
/*
* BFA TRC
*/

Expand Down Expand Up @@ -73,7 +73,7 @@ enum {
#define BFA_TRC_MOD_SH 10
#define BFA_TRC_MOD(__mod) ((BFA_TRC_ ## __mod) << BFA_TRC_MOD_SH)

/**
/*
* Define a new tracing file (module). Module should match one defined above.
*/
#define BFA_TRC_FILE(__mod, __submod) \
Expand Down Expand Up @@ -155,7 +155,7 @@ __bfa_trc32(struct bfa_trc_mod_s *trcm, int fileno, int line, u32 data)
#define bfa_trc_fp(_trcp, _data)
#endif

/**
/*
* @ BFA LOG interfaces
*/
#define bfa_assert(__cond) do { \
Expand Down Expand Up @@ -249,13 +249,13 @@ bfa_q_is_on_q_func(struct list_head *q, struct list_head *qe)
#define bfa_q_is_on_q(_q, _qe) \
bfa_q_is_on_q_func(_q, (struct list_head *)(_qe))

/**
/*
* @ BFA state machine interfaces
*/

typedef void (*bfa_sm_t)(void *sm, int event);

/**
/*
* oc - object class eg. bfa_ioc
* st - state, eg. reset
* otype - object type, eg. struct bfa_ioc_s
Expand All @@ -269,7 +269,7 @@ typedef void (*bfa_sm_t)(void *sm, int event);
#define bfa_sm_get_state(_sm) ((_sm)->sm)
#define bfa_sm_cmp_state(_sm, _state) ((_sm)->sm == (bfa_sm_t)(_state))

/**
/*
* For converting from state machine function to state encoding.
*/
struct bfa_sm_table_s {
Expand All @@ -279,12 +279,12 @@ struct bfa_sm_table_s {
};
#define BFA_SM(_sm) ((bfa_sm_t)(_sm))

/**
/*
* State machine with entry actions.
*/
typedef void (*bfa_fsm_t)(void *fsm, int event);

/**
/*
* oc - object class eg. bfa_ioc
* st - state, eg. reset
* otype - object type, eg. struct bfa_ioc_s
Expand Down Expand Up @@ -314,7 +314,7 @@ bfa_sm_to_state(struct bfa_sm_table_s *smt, bfa_sm_t sm)
return smt[i].state;
}

/**
/*
* @ Generic wait counter.
*/

Expand All @@ -340,7 +340,7 @@ bfa_wc_down(struct bfa_wc_s *wc)
wc->wc_resume(wc->wc_cbarg);
}

/**
/*
* Initialize a waiting counter.
*/
static inline void
Expand All @@ -352,7 +352,7 @@ bfa_wc_init(struct bfa_wc_s *wc, bfa_wc_resume_t wc_resume, void *wc_cbarg)
bfa_wc_up(wc);
}

/**
/*
* Wait for counter to reach zero
*/
static inline void
Expand Down
Loading

0 comments on commit acdc79a

Please sign in to comment.