bnx2x: Unify PHY attributes
[linux-2.6.git] / drivers / net / bnx2x / bnx2x_link.h
1 /* Copyright 2008-2010 Broadcom Corporation
2  *
3  * Unless you and Broadcom execute a separate written software license
4  * agreement governing use of this software, this software is licensed to you
5  * under the terms of the GNU General Public License version 2, available
6  * at http://www.gnu.org/licenses/old-licenses/gpl-2.0.html (the "GPL").
7  *
8  * Notwithstanding the above, under no circumstances may you combine this
9  * software in any way with any other Broadcom software provided under a
10  * license other than the GPL, without Broadcom's express prior written
11  * consent.
12  *
13  * Written by Yaniv Rosner
14  *
15  */
16
17 #ifndef BNX2X_LINK_H
18 #define BNX2X_LINK_H
19
20
21
22 /***********************************************************/
23 /*                         Defines                         */
24 /***********************************************************/
25 #define DEFAULT_PHY_DEV_ADDR 3
26
27
28
29 #define BNX2X_FLOW_CTRL_AUTO            PORT_FEATURE_FLOW_CONTROL_AUTO
30 #define BNX2X_FLOW_CTRL_TX              PORT_FEATURE_FLOW_CONTROL_TX
31 #define BNX2X_FLOW_CTRL_RX              PORT_FEATURE_FLOW_CONTROL_RX
32 #define BNX2X_FLOW_CTRL_BOTH            PORT_FEATURE_FLOW_CONTROL_BOTH
33 #define BNX2X_FLOW_CTRL_NONE            PORT_FEATURE_FLOW_CONTROL_NONE
34
35 #define SPEED_AUTO_NEG      0
36 #define SPEED_12000             12000
37 #define SPEED_12500             12500
38 #define SPEED_13000             13000
39 #define SPEED_15000             15000
40 #define SPEED_16000             16000
41
42 #define SFP_EEPROM_VENDOR_NAME_ADDR             0x14
43 #define SFP_EEPROM_VENDOR_NAME_SIZE             16
44 #define SFP_EEPROM_VENDOR_OUI_ADDR              0x25
45 #define SFP_EEPROM_VENDOR_OUI_SIZE              3
46 #define SFP_EEPROM_PART_NO_ADDR                 0x28
47 #define SFP_EEPROM_PART_NO_SIZE         16
48 #define PWR_FLT_ERR_MSG_LEN                     250
49 /* Single Media Direct board is the plain 577xx board with CX4/RJ45 jacks */
50 #define SINGLE_MEDIA_DIRECT(params)     (params->num_phys == 1)
51 /* Single Media board contains single external phy */
52 #define SINGLE_MEDIA(params)            (params->num_phys == 2)
53 /***********************************************************/
54 /*                         Structs                         */
55 /***********************************************************/
56 #define INT_PHY         0
57 #define EXT_PHY1        1
58
59 #define MAX_PHYS        2
60
61 /***********************************************************/
62 /*                      bnx2x_phy struct                     */
63 /*  Defines the required arguments and function per phy    */
64 /***********************************************************/
65 struct link_vars;
66 struct link_params;
67 struct bnx2x_phy;
68
69 struct bnx2x_phy {
70         u32 type;
71
72         /* Loaded during init */
73         u8 addr;
74
75         u32 mdio_ctrl;
76 };
77
78 /* Inputs parameters to the CLC */
79 struct link_params {
80
81         u8 port;
82
83         /* Default / User Configuration */
84         u8 loopback_mode;
85 #define LOOPBACK_NONE   0
86 #define LOOPBACK_EMAC   1
87 #define LOOPBACK_BMAC   2
88 #define LOOPBACK_XGXS_10        3
89 #define LOOPBACK_EXT_PHY        4
90 #define LOOPBACK_EXT    5
91
92         u16 req_duplex;
93         u16 req_flow_ctrl;
94         u16 req_fc_auto_adv; /* Should be set to TX / BOTH when
95         req_flow_ctrl is set to AUTO */
96         u16 req_line_speed; /* Also determine AutoNeg */
97
98         /* Device parameters */
99         u8 mac_addr[6];
100
101         /* shmem parameters */
102         u32 shmem_base;
103         u32 speed_cap_mask;
104         u32 switch_cfg;
105 #define SWITCH_CFG_1G           PORT_FEATURE_CON_SWITCH_1G_SWITCH
106 #define SWITCH_CFG_10G          PORT_FEATURE_CON_SWITCH_10G_SWITCH
107 #define SWITCH_CFG_AUTO_DETECT  PORT_FEATURE_CON_SWITCH_AUTO_DETECT
108
109         u16 hw_led_mode; /* part of the hw_config read from the shmem */
110
111         /* phy_addr populated by the phy_init function */
112         u8 phy_addr;
113         /*u8 reserved1;*/
114
115         u32 lane_config;
116         u32 ext_phy_config;
117 #define XGXS_EXT_PHY_TYPE(ext_phy_config) \
118                 ((ext_phy_config) & PORT_HW_CFG_XGXS_EXT_PHY_TYPE_MASK)
119 #define XGXS_EXT_PHY_ADDR(ext_phy_config) \
120                 (((ext_phy_config) & PORT_HW_CFG_XGXS_EXT_PHY_ADDR_MASK) >> \
121                  PORT_HW_CFG_XGXS_EXT_PHY_ADDR_SHIFT)
122 #define SERDES_EXT_PHY_TYPE(ext_phy_config) \
123                 ((ext_phy_config) & PORT_HW_CFG_SERDES_EXT_PHY_TYPE_MASK)
124
125         /* Phy register parameter */
126         u32 chip_id;
127
128         u16 xgxs_config_rx[4]; /* preemphasis values for the rx side */
129         u16 xgxs_config_tx[4]; /* preemphasis values for the tx side */
130
131         u32 feature_config_flags;
132 #define FEATURE_CONFIG_OVERRIDE_PREEMPHASIS_ENABLED (1<<0)
133 #define FEATURE_CONFIG_BC_SUPPORTS_OPT_MDL_VRFY (1<<2)
134 #define FEATURE_CONFIG_BCM8727_NOC                      (1<<3)
135         /* Will be populated during common init */
136         struct bnx2x_phy phy[MAX_PHYS];
137
138         /* Will be populated during common init */
139         u8 num_phys;
140
141         /* Device pointer passed to all callback functions */
142         struct bnx2x *bp;
143 };
144
145 /* Output parameters */
146 struct link_vars {
147         u8 phy_flags;
148
149         u8 mac_type;
150 #define MAC_TYPE_NONE           0
151 #define MAC_TYPE_EMAC           1
152 #define MAC_TYPE_BMAC           2
153
154         u8 phy_link_up; /* internal phy link indication */
155         u8 link_up;
156
157         u16 line_speed;
158         u16 duplex;
159
160         u16 flow_ctrl;
161         u16 ieee_fc;
162
163         u32 autoneg;
164 #define AUTO_NEG_DISABLED                       0x0
165 #define AUTO_NEG_ENABLED                        0x1
166 #define AUTO_NEG_COMPLETE                       0x2
167 #define AUTO_NEG_PARALLEL_DETECTION_USED        0x3
168
169         /* The same definitions as the shmem parameter */
170         u32 link_status;
171 };
172
173 /***********************************************************/
174 /*                         Functions                       */
175 /***********************************************************/
176
177 /* Initialize the phy */
178 u8 bnx2x_phy_init(struct link_params *input, struct link_vars *output);
179
180 /* Reset the link. Should be called when driver or interface goes down
181    Before calling phy firmware upgrade, the reset_ext_phy should be set
182    to 0 */
183 u8 bnx2x_link_reset(struct link_params *params, struct link_vars *vars,
184                   u8 reset_ext_phy);
185
186 /* bnx2x_link_update should be called upon link interrupt */
187 u8 bnx2x_link_update(struct link_params *input, struct link_vars *output);
188
189 /* use the following phy functions to read/write from external_phy
190   In order to use it to read/write internal phy registers, use
191   DEFAULT_PHY_DEV_ADDR as devad, and (_bank + (_addr & 0xf)) as
192   the register */
193 u8 bnx2x_phy_read(struct link_params *params, u8 phy_addr,
194                   u8 devad, u16 reg, u16 *ret_val);
195
196 u8 bnx2x_phy_write(struct link_params *params, u8 phy_addr,
197                    u8 devad, u16 reg, u16 val);
198 u8 bnx2x_cl45_read(struct bnx2x *bp, struct bnx2x_phy *phy,
199                    u8 devad, u16 reg, u16 *ret_val);
200
201 u8 bnx2x_cl45_write(struct bnx2x *bp, struct bnx2x_phy *phy,
202                     u8 devad, u16 reg, u16 val);
203 /* Reads the link_status from the shmem,
204    and update the link vars accordingly */
205 void bnx2x_link_status_update(struct link_params *input,
206                             struct link_vars *output);
207 /* returns string representing the fw_version of the external phy */
208 u8 bnx2x_get_ext_phy_fw_version(struct link_params *params, u8 driver_loaded,
209                               u8 *version, u16 len);
210
211 /* Set/Unset the led
212    Basically, the CLC takes care of the led for the link, but in case one needs
213    to set/unset the led unnaturally, set the "mode" to LED_MODE_OPER to
214    blink the led, and LED_MODE_OFF to set the led off.*/
215 u8 bnx2x_set_led(struct link_params *params, u8 mode, u32 speed);
216 #define LED_MODE_OFF    0
217 #define LED_MODE_OPER   2
218
219 u8 bnx2x_override_led_value(struct bnx2x *bp, u8 port, u32 led_idx, u32 value);
220
221 /* bnx2x_handle_module_detect_int should be called upon module detection
222    interrupt */
223 void bnx2x_handle_module_detect_int(struct link_params *params);
224
225 /* Get the actual link status. In case it returns 0, link is up,
226         otherwise link is down*/
227 u8 bnx2x_test_link(struct link_params *input, struct link_vars *vars);
228
229 /* One-time initialization for external phy after power up */
230 u8 bnx2x_common_init_phy(struct bnx2x *bp, u32 shmem_base);
231
232 /* Reset the external PHY using GPIO */
233 void bnx2x_ext_phy_hw_reset(struct bnx2x *bp, u8 port);
234
235 /* Reset the external of SFX7101 */
236 void bnx2x_sfx7101_sp_sw_reset(struct bnx2x *bp, struct bnx2x_phy *phy);
237
238 u8 bnx2x_read_sfp_module_eeprom(struct bnx2x_phy *phy,
239                                 struct link_params *params, u16 addr,
240                               u8 byte_cnt, u8 *o_buf);
241 /* Returns the aggregative supported attributes of the phys on board */
242 u32 bnx2x_supported_attr(struct link_params *params, u8 phy_idx);
243 /* Probe the phys on board, and populate them in "params" */
244 u8 bnx2x_phy_probe(struct link_params *params);
245 #endif /* BNX2X_LINK_H */