2f12d68021d57d4ee7924cb45746bca5acf6be30
[linux-2.6.git] / drivers / net / ethernet / brocade / bna / bfa_defs.h
1 /*
2  * Linux network driver for Brocade Converged Network Adapter.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License (GPL) Version 2 as
6  * published by the Free Software Foundation
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  */
13 /*
14  * Copyright (c) 2005-2010 Brocade Communications Systems, Inc.
15  * All rights reserved
16  * www.brocade.com
17  */
18
19 #ifndef __BFA_DEFS_H__
20 #define __BFA_DEFS_H__
21
22 #include "cna.h"
23 #include "bfa_defs_status.h"
24 #include "bfa_defs_mfg_comm.h"
25
26 #define BFA_STRING_32   32
27 #define BFA_VERSION_LEN 64
28
29 /**
30  * ---------------------- adapter definitions ------------
31  */
32
33 /**
34  * BFA adapter level attributes.
35  */
36 enum {
37         BFA_ADAPTER_SERIAL_NUM_LEN = STRSZ(BFA_MFG_SERIALNUM_SIZE),
38                                         /*
39                                          *!< adapter serial num length
40                                          */
41         BFA_ADAPTER_MODEL_NAME_LEN  = 16,  /*!< model name length */
42         BFA_ADAPTER_MODEL_DESCR_LEN = 128, /*!< model description length */
43         BFA_ADAPTER_MFG_NAME_LEN    = 8,   /*!< manufacturer name length */
44         BFA_ADAPTER_SYM_NAME_LEN    = 64,  /*!< adapter symbolic name length */
45         BFA_ADAPTER_OS_TYPE_LEN     = 64,  /*!< adapter os type length */
46 };
47
48 struct bfa_adapter_attr {
49         char            manufacturer[BFA_ADAPTER_MFG_NAME_LEN];
50         char            serial_num[BFA_ADAPTER_SERIAL_NUM_LEN];
51         u32     card_type;
52         char            model[BFA_ADAPTER_MODEL_NAME_LEN];
53         char            model_descr[BFA_ADAPTER_MODEL_DESCR_LEN];
54         u64             pwwn;
55         char            node_symname[FC_SYMNAME_MAX];
56         char            hw_ver[BFA_VERSION_LEN];
57         char            fw_ver[BFA_VERSION_LEN];
58         char            optrom_ver[BFA_VERSION_LEN];
59         char            os_type[BFA_ADAPTER_OS_TYPE_LEN];
60         struct bfa_mfg_vpd vpd;
61         struct mac mac;
62
63         u8              nports;
64         u8              max_speed;
65         u8              prototype;
66         char            asic_rev;
67
68         u8              pcie_gen;
69         u8              pcie_lanes_orig;
70         u8              pcie_lanes;
71         u8              cna_capable;
72
73         u8              is_mezz;
74         u8              trunk_capable;
75 };
76
77 /**
78  * ---------------------- IOC definitions ------------
79  */
80
81 enum {
82         BFA_IOC_DRIVER_LEN      = 16,
83         BFA_IOC_CHIP_REV_LEN    = 8,
84 };
85
86 /**
87  * Driver and firmware versions.
88  */
89 struct bfa_ioc_driver_attr {
90         char            driver[BFA_IOC_DRIVER_LEN];     /*!< driver name */
91         char            driver_ver[BFA_VERSION_LEN];    /*!< driver version */
92         char            fw_ver[BFA_VERSION_LEN];        /*!< firmware version */
93         char            bios_ver[BFA_VERSION_LEN];      /*!< bios version */
94         char            efi_ver[BFA_VERSION_LEN];       /*!< EFI version */
95         char            ob_ver[BFA_VERSION_LEN];        /*!< openboot version */
96 };
97
98 /**
99  * IOC PCI device attributes
100  */
101 struct bfa_ioc_pci_attr {
102         u16     vendor_id;      /*!< PCI vendor ID */
103         u16     device_id;      /*!< PCI device ID */
104         u16     ssid;           /*!< subsystem ID */
105         u16     ssvid;          /*!< subsystem vendor ID */
106         u32     pcifn;          /*!< PCI device function */
107         u32     rsvd;           /* padding */
108         char            chip_rev[BFA_IOC_CHIP_REV_LEN];  /*!< chip revision */
109 };
110
111 /**
112  * IOC states
113  */
114 enum bfa_ioc_state {
115         BFA_IOC_UNINIT          = 1,    /*!< IOC is in uninit state */
116         BFA_IOC_RESET           = 2,    /*!< IOC is in reset state */
117         BFA_IOC_SEMWAIT         = 3,    /*!< Waiting for IOC h/w semaphore */
118         BFA_IOC_HWINIT          = 4,    /*!< IOC h/w is being initialized */
119         BFA_IOC_GETATTR         = 5,    /*!< IOC is being configured */
120         BFA_IOC_OPERATIONAL     = 6,    /*!< IOC is operational */
121         BFA_IOC_INITFAIL        = 7,    /*!< IOC hardware failure */
122         BFA_IOC_FAIL            = 8,    /*!< IOC heart-beat failure */
123         BFA_IOC_DISABLING       = 9,    /*!< IOC is being disabled */
124         BFA_IOC_DISABLED        = 10,   /*!< IOC is disabled */
125         BFA_IOC_FWMISMATCH      = 11,   /*!< IOC f/w different from drivers */
126         BFA_IOC_ENABLING        = 12,   /*!< IOC is being enabled */
127         BFA_IOC_HWFAIL          = 13,   /*!< PCI mapping doesn't exist */
128 };
129
130 /**
131  * IOC firmware stats
132  */
133 struct bfa_fw_ioc_stats {
134         u32     enable_reqs;
135         u32     disable_reqs;
136         u32     get_attr_reqs;
137         u32     dbg_sync;
138         u32     dbg_dump;
139         u32     unknown_reqs;
140 };
141
142 /**
143  * IOC driver stats
144  */
145 struct bfa_ioc_drv_stats {
146         u32     ioc_isrs;
147         u32     ioc_enables;
148         u32     ioc_disables;
149         u32     ioc_hbfails;
150         u32     ioc_boots;
151         u32     stats_tmos;
152         u32     hb_count;
153         u32     disable_reqs;
154         u32     enable_reqs;
155         u32     disable_replies;
156         u32     enable_replies;
157         u32     rsvd;
158 };
159
160 /**
161  * IOC statistics
162  */
163 struct bfa_ioc_stats {
164         struct bfa_ioc_drv_stats drv_stats; /*!< driver IOC stats */
165         struct bfa_fw_ioc_stats fw_stats;  /*!< firmware IOC stats */
166 };
167
168 enum bfa_ioc_type {
169         BFA_IOC_TYPE_FC         = 1,
170         BFA_IOC_TYPE_FCoE       = 2,
171         BFA_IOC_TYPE_LL         = 3,
172 };
173
174 /**
175  * IOC attributes returned in queries
176  */
177 struct bfa_ioc_attr {
178         enum bfa_ioc_type ioc_type;
179         enum bfa_ioc_state              state;          /*!< IOC state      */
180         struct bfa_adapter_attr adapter_attr;   /*!< HBA attributes */
181         struct bfa_ioc_driver_attr driver_attr; /*!< driver attr    */
182         struct bfa_ioc_pci_attr pci_attr;
183         u8                              port_id;        /*!< port number */
184         u8                              port_mode;      /*!< enum bfa_mode */
185         u8                              cap_bm;         /*!< capability */
186         u8                              port_mode_cfg;  /*!< enum bfa_mode */
187         u8                              rsvd[4];        /*!< 64bit align */
188 };
189
190 /**
191  * Adapter capability mask definition
192  */
193 enum {
194         BFA_CM_HBA      =       0x01,
195         BFA_CM_CNA      =       0x02,
196         BFA_CM_NIC      =       0x04,
197 };
198
199 /**
200  * ---------------------- mfg definitions ------------
201  */
202
203 /**
204  * Checksum size
205  */
206 #define BFA_MFG_CHKSUM_SIZE                     16
207
208 #define BFA_MFG_PARTNUM_SIZE                    14
209 #define BFA_MFG_SUPPLIER_ID_SIZE                10
210 #define BFA_MFG_SUPPLIER_PARTNUM_SIZE           20
211 #define BFA_MFG_SUPPLIER_SERIALNUM_SIZE         20
212 #define BFA_MFG_SUPPLIER_REVISION_SIZE          4
213
214 #pragma pack(1)
215
216 /**
217  * @brief BFA adapter manufacturing block definition.
218  *
219  * All numerical fields are in big-endian format.
220  */
221 struct bfa_mfg_block {
222         u8              version;        /*!< manufacturing block version */
223         u8              mfg_sig[3];     /*!< characters 'M', 'F', 'G' */
224         u16     mfgsize;        /*!< mfg block size */
225         u16     u16_chksum;     /*!< old u16 checksum */
226         char            brcd_serialnum[STRSZ(BFA_MFG_SERIALNUM_SIZE)];
227         char            brcd_partnum[STRSZ(BFA_MFG_PARTNUM_SIZE)];
228         u8              mfg_day;        /*!< manufacturing day */
229         u8              mfg_month;      /*!< manufacturing month */
230         u16     mfg_year;       /*!< manufacturing year */
231         u64             mfg_wwn;        /*!< wwn base for this adapter */
232         u8              num_wwn;        /*!< number of wwns assigned */
233         u8              mfg_speeds;     /*!< speeds allowed for this adapter */
234         u8              rsv[2];
235         char            supplier_id[STRSZ(BFA_MFG_SUPPLIER_ID_SIZE)];
236         char            supplier_partnum[STRSZ(BFA_MFG_SUPPLIER_PARTNUM_SIZE)];
237         char
238                 supplier_serialnum[STRSZ(BFA_MFG_SUPPLIER_SERIALNUM_SIZE)];
239         char
240                 supplier_revision[STRSZ(BFA_MFG_SUPPLIER_REVISION_SIZE)];
241         mac_t           mfg_mac;        /*!< mac address */
242         u8              num_mac;        /*!< number of mac addresses */
243         u8              rsv2;
244         u32             card_type;      /*!< card type */
245         char            cap_nic;        /*!< capability nic */
246         char            cap_cna;        /*!< capability cna */
247         char            cap_hba;        /*!< capability hba */
248         char            cap_fc16g;      /*!< capability fc 16g */
249         char            cap_sriov;      /*!< capability sriov */
250         char            cap_mezz;       /*!< capability mezz */
251         u8              rsv3;
252         u8              mfg_nports;     /*!< number of ports */
253         char            media[8];       /*!< xfi/xaui */
254         char            initial_mode[8];/*!< initial mode: hba/cna/nic */
255         u8              rsv4[84];
256         u8              md5_chksum[BFA_MFG_CHKSUM_SIZE]; /*!< md5 checksum */
257 };
258
259 #pragma pack()
260
261 /**
262  * ---------------------- pci definitions ------------
263  */
264
265 /*
266  * PCI device ID information
267  */
268 enum {
269         BFA_PCI_DEVICE_ID_CT2           = 0x22,
270 };
271
272 #define bfa_asic_id_ct(device)                  \
273         ((device) == PCI_DEVICE_ID_BROCADE_CT ||        \
274          (device) == PCI_DEVICE_ID_BROCADE_CT_FC)
275 #define bfa_asic_id_ct2(device)                 \
276         ((device) == BFA_PCI_DEVICE_ID_CT2)
277 #define bfa_asic_id_ctc(device)                 \
278         (bfa_asic_id_ct(device) || bfa_asic_id_ct2(device))
279
280 /**
281  * PCI sub-system device and vendor ID information
282  */
283 enum {
284         BFA_PCI_FCOE_SSDEVICE_ID        = 0x14,
285         BFA_PCI_CT2_SSID_FCoE           = 0x22,
286         BFA_PCI_CT2_SSID_ETH            = 0x23,
287         BFA_PCI_CT2_SSID_FC             = 0x24,
288 };
289
290 enum bfa_mode {
291         BFA_MODE_HBA            = 1,
292         BFA_MODE_CNA            = 2,
293         BFA_MODE_NIC            = 3
294 };
295
296 #endif /* __BFA_DEFS_H__ */