Commit 70b51aab authored by Robert Love's avatar Robert Love Committed by James Bottomley

[SCSI] libfcoe: formatting and comment cleanups

Ensures that there are kernel-doc style comments for all
routines and structures.

There were also a few instances of fc_lport's named 'lp'
which were switched to 'lport' as per the libfc/libfcoe/fcoe
naming convention.

Also, emacs 'indent-region' and 'tabify' were ran on libfcoe.c.
Signed-off-by: default avatarRobert Love <robert.w.love@intel.com>
Signed-off-by: default avatarJames Bottomley <James.Bottomley@suse.de>
parent 3a3b42bf
This diff is collapsed.
...@@ -53,35 +53,35 @@ enum fip_state { ...@@ -53,35 +53,35 @@ enum fip_state {
}; };
/** /**
* struct fcoe_ctlr - FCoE Controller and FIP state. * struct fcoe_ctlr - FCoE Controller and FIP state
* @state: internal FIP state for network link and FIP or non-FIP mode. * @state: internal FIP state for network link and FIP or non-FIP mode.
* @lp: &fc_lport: libfc local port. * @lp: &fc_lport: libfc local port.
* @sel_fcf: currently selected FCF, or NULL. * @sel_fcf: currently selected FCF, or NULL.
* @fcfs: list of discovered FCFs. * @fcfs: list of discovered FCFs.
* @fcf_count: number of discovered FCF entries. * @fcf_count: number of discovered FCF entries.
* @sol_time: time when a multicast solicitation was last sent. * @sol_time: time when a multicast solicitation was last sent.
* @sel_time: time after which to select an FCF. * @sel_time: time after which to select an FCF.
* @port_ka_time: time of next port keep-alive. * @port_ka_time: time of next port keep-alive.
* @ctlr_ka_time: time of next controller keep-alive. * @ctlr_ka_time: time of next controller keep-alive.
* @timer: timer struct used for all delayed events. * @timer: timer struct used for all delayed events.
* @link_work: &work_struct for doing FCF selection. * @link_work: &work_struct for doing FCF selection.
* @recv_work: &work_struct for receiving FIP frames. * @recv_work: &work_struct for receiving FIP frames.
* @fip_recv_list: list of received FIP frames. * @fip_recv_list: list of received FIP frames.
* @user_mfs: configured maximum FC frame size, including FC header. * @user_mfs: configured maximum FC frame size, including FC header.
* @flogi_oxid: exchange ID of most recent fabric login. * @flogi_oxid: exchange ID of most recent fabric login.
* @flogi_count: number of FLOGI attempts in AUTO mode. * @flogi_count: number of FLOGI attempts in AUTO mode.
* @link: current link status for libfc. * @link: current link status for libfc.
* @last_link: last link state reported to libfc. * @last_link: last link state reported to libfc.
* @map_dest: use the FC_MAP mode for destination MAC addresses. * @map_dest: use the FC_MAP mode for destination MAC addresses.
* @spma: supports SPMA server-provided MACs mode * @spma: supports SPMA server-provided MACs mode
* @send_ctlr_ka: need to send controller keep alive * @send_ctlr_ka: need to send controller keep alive
* @send_port_ka: need to send port keep alives * @send_port_ka: need to send port keep alives
* @dest_addr: MAC address of the selected FC forwarder. * @dest_addr: MAC address of the selected FC forwarder.
* @ctl_src_addr: the native MAC address of our local port. * @ctl_src_addr: the native MAC address of our local port.
* @send: LLD-supplied function to handle sending of FIP Ethernet frames. * @send: LLD-supplied function to handle sending FIP Ethernet frames
* @update_mac: LLD-supplied function to handle changes to MAC addresses. * @update_mac: LLD-supplied function to handle changes to MAC addresses.
* @get_src_addr: LLD-supplied function to supply a source MAC address. * @get_src_addr: LLD-supplied function to supply a source MAC address.
* @lock: lock protecting this structure. * @lock: lock protecting this structure.
* *
* This structure is used by all FCoE drivers. It contains information * This structure is used by all FCoE drivers. It contains information
* needed by all FCoE low-level drivers (LLDs) as well as internal state * needed by all FCoE low-level drivers (LLDs) as well as internal state
...@@ -119,18 +119,18 @@ struct fcoe_ctlr { ...@@ -119,18 +119,18 @@ struct fcoe_ctlr {
spinlock_t lock; spinlock_t lock;
}; };
/* /**
* struct fcoe_fcf - Fibre-Channel Forwarder. * struct fcoe_fcf - Fibre-Channel Forwarder
* @list: list linkage. * @list: list linkage
* @time: system time (jiffies) when an advertisement was last received. * @time: system time (jiffies) when an advertisement was last received
* @switch_name: WWN of switch from advertisement. * @switch_name: WWN of switch from advertisement
* @fabric_name: WWN of fabric from advertisement. * @fabric_name: WWN of fabric from advertisement
* @fc_map: FC_MAP value from advertisement. * @fc_map: FC_MAP value from advertisement
* @fcf_mac: Ethernet address of the FCF. * @fcf_mac: Ethernet address of the FCF
* @vfid: virtual fabric ID. * @vfid: virtual fabric ID
* @pri: seletion priority, smaller values are better. * @pri: selection priority, smaller values are better
* @flags: flags received from advertisement. * @flags: flags received from advertisement
* @fka_period: keep-alive period, in jiffies. * @fka_period: keep-alive period, in jiffies
* *
* A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that
* passes FCoE frames on to an FC fabric. This structure represents * passes FCoE frames on to an FC fabric. This structure represents
...@@ -161,8 +161,8 @@ void fcoe_ctlr_link_up(struct fcoe_ctlr *); ...@@ -161,8 +161,8 @@ void fcoe_ctlr_link_up(struct fcoe_ctlr *);
int fcoe_ctlr_link_down(struct fcoe_ctlr *); int fcoe_ctlr_link_down(struct fcoe_ctlr *);
int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *); int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *);
void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *); void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *);
int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *lport, int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *,
struct fc_frame *fp, u8 *sa); struct fc_frame *, u8 *);
/* libfcoe funcs */ /* libfcoe funcs */
u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int); u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment