diff options
author | Robert Love <robert.w.love@intel.com> | 2009-11-03 14:47:45 -0500 |
---|---|---|
committer | James Bottomley <James.Bottomley@suse.de> | 2009-12-04 13:01:07 -0500 |
commit | 70b51aabf3b03fbf8d61c14847ccce4c69fb0cdd (patch) | |
tree | fbb86fc791fccbfdcd931ec37409d8da2c88c81c /include | |
parent | 3a3b42bf89a9b90ae9ed2c57fdc378e5473a0ef9 (diff) |
[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: Robert Love <robert.w.love@intel.com>
Signed-off-by: James Bottomley <James.Bottomley@suse.de>
Diffstat (limited to 'include')
-rw-r--r-- | include/scsi/libfcoe.h | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/include/scsi/libfcoe.h b/include/scsi/libfcoe.h index 8ef5e209c216..76d08c9a7678 100644 --- a/include/scsi/libfcoe.h +++ b/include/scsi/libfcoe.h | |||
@@ -53,35 +53,35 @@ enum fip_state { | |||
53 | }; | 53 | }; |
54 | 54 | ||
55 | /** | 55 | /** |
56 | * struct fcoe_ctlr - FCoE Controller and FIP state. | 56 | * struct fcoe_ctlr - FCoE Controller and FIP state |
57 | * @state: internal FIP state for network link and FIP or non-FIP mode. | 57 | * @state: internal FIP state for network link and FIP or non-FIP mode. |
58 | * @lp: &fc_lport: libfc local port. | 58 | * @lp: &fc_lport: libfc local port. |
59 | * @sel_fcf: currently selected FCF, or NULL. | 59 | * @sel_fcf: currently selected FCF, or NULL. |
60 | * @fcfs: list of discovered FCFs. | 60 | * @fcfs: list of discovered FCFs. |
61 | * @fcf_count: number of discovered FCF entries. | 61 | * @fcf_count: number of discovered FCF entries. |
62 | * @sol_time: time when a multicast solicitation was last sent. | 62 | * @sol_time: time when a multicast solicitation was last sent. |
63 | * @sel_time: time after which to select an FCF. | 63 | * @sel_time: time after which to select an FCF. |
64 | * @port_ka_time: time of next port keep-alive. | 64 | * @port_ka_time: time of next port keep-alive. |
65 | * @ctlr_ka_time: time of next controller keep-alive. | 65 | * @ctlr_ka_time: time of next controller keep-alive. |
66 | * @timer: timer struct used for all delayed events. | 66 | * @timer: timer struct used for all delayed events. |
67 | * @link_work: &work_struct for doing FCF selection. | 67 | * @link_work: &work_struct for doing FCF selection. |
68 | * @recv_work: &work_struct for receiving FIP frames. | 68 | * @recv_work: &work_struct for receiving FIP frames. |
69 | * @fip_recv_list: list of received FIP frames. | 69 | * @fip_recv_list: list of received FIP frames. |
70 | * @user_mfs: configured maximum FC frame size, including FC header. | 70 | * @user_mfs: configured maximum FC frame size, including FC header. |
71 | * @flogi_oxid: exchange ID of most recent fabric login. | 71 | * @flogi_oxid: exchange ID of most recent fabric login. |
72 | * @flogi_count: number of FLOGI attempts in AUTO mode. | 72 | * @flogi_count: number of FLOGI attempts in AUTO mode. |
73 | * @link: current link status for libfc. | 73 | * @link: current link status for libfc. |
74 | * @last_link: last link state reported to libfc. | 74 | * @last_link: last link state reported to libfc. |
75 | * @map_dest: use the FC_MAP mode for destination MAC addresses. | 75 | * @map_dest: use the FC_MAP mode for destination MAC addresses. |
76 | * @spma: supports SPMA server-provided MACs mode | 76 | * @spma: supports SPMA server-provided MACs mode |
77 | * @send_ctlr_ka: need to send controller keep alive | 77 | * @send_ctlr_ka: need to send controller keep alive |
78 | * @send_port_ka: need to send port keep alives | 78 | * @send_port_ka: need to send port keep alives |
79 | * @dest_addr: MAC address of the selected FC forwarder. | 79 | * @dest_addr: MAC address of the selected FC forwarder. |
80 | * @ctl_src_addr: the native MAC address of our local port. | 80 | * @ctl_src_addr: the native MAC address of our local port. |
81 | * @send: LLD-supplied function to handle sending of FIP Ethernet frames. | 81 | * @send: LLD-supplied function to handle sending FIP Ethernet frames |
82 | * @update_mac: LLD-supplied function to handle changes to MAC addresses. | 82 | * @update_mac: LLD-supplied function to handle changes to MAC addresses. |
83 | * @get_src_addr: LLD-supplied function to supply a source MAC address. | 83 | * @get_src_addr: LLD-supplied function to supply a source MAC address. |
84 | * @lock: lock protecting this structure. | 84 | * @lock: lock protecting this structure. |
85 | * | 85 | * |
86 | * This structure is used by all FCoE drivers. It contains information | 86 | * This structure is used by all FCoE drivers. It contains information |
87 | * needed by all FCoE low-level drivers (LLDs) as well as internal state | 87 | * needed by all FCoE low-level drivers (LLDs) as well as internal state |
@@ -119,18 +119,18 @@ struct fcoe_ctlr { | |||
119 | spinlock_t lock; | 119 | spinlock_t lock; |
120 | }; | 120 | }; |
121 | 121 | ||
122 | /* | 122 | /** |
123 | * struct fcoe_fcf - Fibre-Channel Forwarder. | 123 | * struct fcoe_fcf - Fibre-Channel Forwarder |
124 | * @list: list linkage. | 124 | * @list: list linkage |
125 | * @time: system time (jiffies) when an advertisement was last received. | 125 | * @time: system time (jiffies) when an advertisement was last received |
126 | * @switch_name: WWN of switch from advertisement. | 126 | * @switch_name: WWN of switch from advertisement |
127 | * @fabric_name: WWN of fabric from advertisement. | 127 | * @fabric_name: WWN of fabric from advertisement |
128 | * @fc_map: FC_MAP value from advertisement. | 128 | * @fc_map: FC_MAP value from advertisement |
129 | * @fcf_mac: Ethernet address of the FCF. | 129 | * @fcf_mac: Ethernet address of the FCF |
130 | * @vfid: virtual fabric ID. | 130 | * @vfid: virtual fabric ID |
131 | * @pri: seletion priority, smaller values are better. | 131 | * @pri: selection priority, smaller values are better |
132 | * @flags: flags received from advertisement. | 132 | * @flags: flags received from advertisement |
133 | * @fka_period: keep-alive period, in jiffies. | 133 | * @fka_period: keep-alive period, in jiffies |
134 | * | 134 | * |
135 | * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that | 135 | * A Fibre-Channel Forwarder (FCF) is the entity on the Ethernet that |
136 | * passes FCoE frames on to an FC fabric. This structure represents | 136 | * passes FCoE frames on to an FC fabric. This structure represents |
@@ -161,8 +161,8 @@ void fcoe_ctlr_link_up(struct fcoe_ctlr *); | |||
161 | int fcoe_ctlr_link_down(struct fcoe_ctlr *); | 161 | int fcoe_ctlr_link_down(struct fcoe_ctlr *); |
162 | int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *); | 162 | int fcoe_ctlr_els_send(struct fcoe_ctlr *, struct fc_lport *, struct sk_buff *); |
163 | void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *); | 163 | void fcoe_ctlr_recv(struct fcoe_ctlr *, struct sk_buff *); |
164 | int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *lport, | 164 | int fcoe_ctlr_recv_flogi(struct fcoe_ctlr *, struct fc_lport *, |
165 | struct fc_frame *fp, u8 *sa); | 165 | struct fc_frame *, u8 *); |
166 | 166 | ||
167 | /* libfcoe funcs */ | 167 | /* libfcoe funcs */ |
168 | u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int); | 168 | u64 fcoe_wwn_from_mac(unsigned char mac[], unsigned int, unsigned int); |