1/* QLogic qed NIC Driver 2 * Copyright (c) 2015 QLogic Corporation 3 * 4 * This software is available under the terms of the GNU General Public License 5 * (GPL) Version 2, available from the file COPYING in the main directory of 6 * this source tree. 7 */ 8 9#ifndef _QED_MCP_H 10#define _QED_MCP_H 11 12#include <linux/types.h> 13#include <linux/delay.h> 14#include <linux/mutex.h> 15#include <linux/slab.h> 16#include "qed_hsi.h" 17 18struct qed_mcp_link_speed_params { 19 bool autoneg; 20 u32 advertised_speeds; /* bitmask of DRV_SPEED_CAPABILITY */ 21 u32 forced_speed; /* In Mb/s */ 22}; 23 24struct qed_mcp_link_pause_params { 25 bool autoneg; 26 bool forced_rx; 27 bool forced_tx; 28}; 29 30struct qed_mcp_link_params { 31 struct qed_mcp_link_speed_params speed; 32 struct qed_mcp_link_pause_params pause; 33 u32 loopback_mode; 34}; 35 36struct qed_mcp_link_capabilities { 37 u32 speed_capabilities; 38}; 39 40struct qed_mcp_link_state { 41 bool link_up; 42 43 u32 speed; /* In Mb/s */ 44 bool full_duplex; 45 46 bool an; 47 bool an_complete; 48 bool parallel_detection; 49 bool pfc_enabled; 50 51#define QED_LINK_PARTNER_SPEED_1G_HD BIT(0) 52#define QED_LINK_PARTNER_SPEED_1G_FD BIT(1) 53#define QED_LINK_PARTNER_SPEED_10G BIT(2) 54#define QED_LINK_PARTNER_SPEED_20G BIT(3) 55#define QED_LINK_PARTNER_SPEED_40G BIT(4) 56#define QED_LINK_PARTNER_SPEED_50G BIT(5) 57#define QED_LINK_PARTNER_SPEED_100G BIT(6) 58 u32 partner_adv_speed; 59 60 bool partner_tx_flow_ctrl_en; 61 bool partner_rx_flow_ctrl_en; 62 63#define QED_LINK_PARTNER_SYMMETRIC_PAUSE (1) 64#define QED_LINK_PARTNER_ASYMMETRIC_PAUSE (2) 65#define QED_LINK_PARTNER_BOTH_PAUSE (3) 66 u8 partner_adv_pause; 67 68 bool sfp_tx_fault; 69}; 70 71struct qed_mcp_function_info { 72 u8 pause_on_host; 73 74 enum qed_pci_personality protocol; 75 76 u8 bandwidth_min; 77 u8 bandwidth_max; 78 79 u8 mac[ETH_ALEN]; 80 81 u64 wwn_port; 82 u64 wwn_node; 83 84#define QED_MCP_VLAN_UNSET (0xffff) 85 u16 ovlan; 86}; 87 88struct qed_mcp_nvm_common { 89 u32 offset; 90 u32 param; 91 u32 resp; 92 u32 cmd; 93}; 94 95struct qed_mcp_drv_version { 96 u32 version; 97 u8 name[MCP_DRV_VER_STR_SIZE - 4]; 98}; 99 100/** 101 * @brief - returns the link params of the hw function 102 * 103 * @param p_hwfn 104 * 105 * @returns pointer to link params 106 */ 107struct qed_mcp_link_params *qed_mcp_get_link_params(struct qed_hwfn *); 108 109/** 110 * @brief - return the link state of the hw function 111 * 112 * @param p_hwfn 113 * 114 * @returns pointer to link state 115 */ 116struct qed_mcp_link_state *qed_mcp_get_link_state(struct qed_hwfn *); 117 118/** 119 * @brief - return the link capabilities of the hw function 120 * 121 * @param p_hwfn 122 * 123 * @returns pointer to link capabilities 124 */ 125struct qed_mcp_link_capabilities 126 *qed_mcp_get_link_capabilities(struct qed_hwfn *p_hwfn); 127 128/** 129 * @brief Request the MFW to set the the link according to 'link_input'. 130 * 131 * @param p_hwfn 132 * @param p_ptt 133 * @param b_up - raise link if `true'. Reset link if `false'. 134 * 135 * @return int 136 */ 137int qed_mcp_set_link(struct qed_hwfn *p_hwfn, 138 struct qed_ptt *p_ptt, 139 bool b_up); 140 141/** 142 * @brief Get the management firmware version value 143 * 144 * @param cdev - qed dev pointer 145 * @param mfw_ver - mfw version value 146 * 147 * @return int - 0 - operation was successul. 148 */ 149int qed_mcp_get_mfw_ver(struct qed_dev *cdev, 150 u32 *mfw_ver); 151 152/** 153 * @brief Get media type value of the port. 154 * 155 * @param cdev - qed dev pointer 156 * @param mfw_ver - media type value 157 * 158 * @return int - 159 * 0 - Operation was successul. 160 * -EBUSY - Operation failed 161 */ 162int qed_mcp_get_media_type(struct qed_dev *cdev, 163 u32 *media_type); 164 165/** 166 * @brief General function for sending commands to the MCP 167 * mailbox. It acquire mutex lock for the entire 168 * operation, from sending the request until the MCP 169 * response. Waiting for MCP response will be checked up 170 * to 5 seconds every 5ms. 171 * 172 * @param p_hwfn - hw function 173 * @param p_ptt - PTT required for register access 174 * @param cmd - command to be sent to the MCP. 175 * @param param - Optional param 176 * @param o_mcp_resp - The MCP response code (exclude sequence). 177 * @param o_mcp_param- Optional parameter provided by the MCP 178 * response 179 * @return int - 0 - operation 180 * was successul. 181 */ 182int qed_mcp_cmd(struct qed_hwfn *p_hwfn, 183 struct qed_ptt *p_ptt, 184 u32 cmd, 185 u32 param, 186 u32 *o_mcp_resp, 187 u32 *o_mcp_param); 188 189/** 190 * @brief - drains the nig, allowing completion to pass in case of pauses. 191 * (Should be called only from sleepable context) 192 * 193 * @param p_hwfn 194 * @param p_ptt 195 */ 196int qed_mcp_drain(struct qed_hwfn *p_hwfn, 197 struct qed_ptt *p_ptt); 198 199/** 200 * @brief Get the flash size value 201 * 202 * @param p_hwfn 203 * @param p_ptt 204 * @param p_flash_size - flash size in bytes to be filled. 205 * 206 * @return int - 0 - operation was successul. 207 */ 208int qed_mcp_get_flash_size(struct qed_hwfn *p_hwfn, 209 struct qed_ptt *p_ptt, 210 u32 *p_flash_size); 211 212/** 213 * @brief Send driver version to MFW 214 * 215 * @param p_hwfn 216 * @param p_ptt 217 * @param version - Version value 218 * @param name - Protocol driver name 219 * 220 * @return int - 0 - operation was successul. 221 */ 222int 223qed_mcp_send_drv_version(struct qed_hwfn *p_hwfn, 224 struct qed_ptt *p_ptt, 225 struct qed_mcp_drv_version *p_ver); 226 227/* Using hwfn number (and not pf_num) is required since in CMT mode, 228 * same pf_num may be used by two different hwfn 229 * TODO - this shouldn't really be in .h file, but until all fields 230 * required during hw-init will be placed in their correct place in shmem 231 * we need it in qed_dev.c [for readin the nvram reflection in shmem]. 232 */ 233#define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (QED_IS_BB((p_hwfn)->cdev) ? \ 234 ((rel_pfid) | \ 235 ((p_hwfn)->abs_pf_id & 1) << 3) : \ 236 rel_pfid) 237#define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id) 238 239/* TODO - this is only correct as long as only BB is supported, and 240 * no port-swapping is implemented; Afterwards we'll need to fix it. 241 */ 242#define MFW_PORT(_p_hwfn) ((_p_hwfn)->abs_pf_id % \ 243 ((_p_hwfn)->cdev->num_ports_in_engines * 2)) 244struct qed_mcp_info { 245 struct mutex mutex; /* MCP access lock */ 246 u32 public_base; 247 u32 drv_mb_addr; 248 u32 mfw_mb_addr; 249 u32 port_addr; 250 u16 drv_mb_seq; 251 u16 drv_pulse_seq; 252 struct qed_mcp_link_params link_input; 253 struct qed_mcp_link_state link_output; 254 struct qed_mcp_link_capabilities link_capabilities; 255 struct qed_mcp_function_info func_info; 256 u8 *mfw_mb_cur; 257 u8 *mfw_mb_shadow; 258 u16 mfw_mb_length; 259 u16 mcp_hist; 260}; 261 262/** 263 * @brief Initialize the interface with the MCP 264 * 265 * @param p_hwfn - HW func 266 * @param p_ptt - PTT required for register access 267 * 268 * @return int 269 */ 270int qed_mcp_cmd_init(struct qed_hwfn *p_hwfn, 271 struct qed_ptt *p_ptt); 272 273/** 274 * @brief Initialize the port interface with the MCP 275 * 276 * @param p_hwfn 277 * @param p_ptt 278 * Can only be called after `num_ports_in_engines' is set 279 */ 280void qed_mcp_cmd_port_init(struct qed_hwfn *p_hwfn, 281 struct qed_ptt *p_ptt); 282/** 283 * @brief Releases resources allocated during the init process. 284 * 285 * @param p_hwfn - HW func 286 * @param p_ptt - PTT required for register access 287 * 288 * @return int 289 */ 290 291int qed_mcp_free(struct qed_hwfn *p_hwfn); 292 293/** 294 * @brief This function is called from the DPC context. After 295 * pointing PTT to the mfw mb, check for events sent by the MCP 296 * to the driver and ack them. In case a critical event 297 * detected, it will be handled here, otherwise the work will be 298 * queued to a sleepable work-queue. 299 * 300 * @param p_hwfn - HW function 301 * @param p_ptt - PTT required for register access 302 * @return int - 0 - operation 303 * was successul. 304 */ 305int qed_mcp_handle_events(struct qed_hwfn *p_hwfn, 306 struct qed_ptt *p_ptt); 307 308/** 309 * @brief Sends a LOAD_REQ to the MFW, and in case operation 310 * succeed, returns whether this PF is the first on the 311 * chip/engine/port or function. This function should be 312 * called when driver is ready to accept MFW events after 313 * Storms initializations are done. 314 * 315 * @param p_hwfn - hw function 316 * @param p_ptt - PTT required for register access 317 * @param p_load_code - The MCP response param containing one 318 * of the following: 319 * FW_MSG_CODE_DRV_LOAD_ENGINE 320 * FW_MSG_CODE_DRV_LOAD_PORT 321 * FW_MSG_CODE_DRV_LOAD_FUNCTION 322 * @return int - 323 * 0 - Operation was successul. 324 * -EBUSY - Operation failed 325 */ 326int qed_mcp_load_req(struct qed_hwfn *p_hwfn, 327 struct qed_ptt *p_ptt, 328 u32 *p_load_code); 329 330/** 331 * @brief Read the MFW mailbox into Current buffer. 332 * 333 * @param p_hwfn 334 * @param p_ptt 335 */ 336void qed_mcp_read_mb(struct qed_hwfn *p_hwfn, 337 struct qed_ptt *p_ptt); 338 339/** 340 * @brief - calls during init to read shmem of all function-related info. 341 * 342 * @param p_hwfn 343 * 344 * @param return 0 upon success. 345 */ 346int qed_mcp_fill_shmem_func_info(struct qed_hwfn *p_hwfn, 347 struct qed_ptt *p_ptt); 348 349/** 350 * @brief - Reset the MCP using mailbox command. 351 * 352 * @param p_hwfn 353 * @param p_ptt 354 * 355 * @param return 0 upon success. 356 */ 357int qed_mcp_reset(struct qed_hwfn *p_hwfn, 358 struct qed_ptt *p_ptt); 359 360/** 361 * @brief indicates whether the MFW objects [under mcp_info] are accessible 362 * 363 * @param p_hwfn 364 * 365 * @return true iff MFW is running and mcp_info is initialized 366 */ 367bool qed_mcp_is_init(struct qed_hwfn *p_hwfn); 368 369#endif 370