xref: /freebsd/sys/dev/bnxt/bnxt_en/bnxt_hwrm.h (revision c9965974a52b5dfad1737706b7f2623d999fb569)
1 /*-
2  * Broadcom NetXtreme-C/E network driver.
3  *
4  * Copyright (c) 2016 Broadcom, All Rights Reserved.
5  * The term Broadcom refers to Broadcom Limited and/or its subsidiaries
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS'
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26  * THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 #ifndef _BNXT_HWRM_H
31 #define _BNXT_HWRM_H
32 
33 #define BNXT_PAUSE_TX 	 (HWRM_PORT_PHY_QCFG_OUTPUT_PAUSE_TX)
34 #define BNXT_PAUSE_RX 	 (HWRM_PORT_PHY_QCFG_OUTPUT_PAUSE_RX)
35 #define BNXT_AUTO_PAUSE_AUTONEG_PAUSE				\
36 	(HWRM_PORT_PHY_QCFG_OUTPUT_AUTO_PAUSE_AUTONEG_PAUSE)
37 #define BNXT_HWRM_SHORT_REQ_LEN	sizeof(struct hwrm_short_input)
38 #define BNXT_BACKING_STORE_CFG_LEGACY_LEN       256
39 #define SHORT_HWRM_CMD_TIMEOUT			500
40 
41 /* HWRM Function Prototypes */
42 int
43 hwrm_send_message(struct bnxt_softc *softc, void *msg, uint32_t msg_len);
44 int bnxt_alloc_hwrm_dma_mem(struct bnxt_softc *softc);
45 void bnxt_free_hwrm_dma_mem(struct bnxt_softc *softc);
46 int bnxt_hwrm_ring_alloc(struct bnxt_softc *softc, uint8_t type,
47 		struct bnxt_ring *ring);
48 int bnxt_hwrm_ring_free(struct bnxt_softc *softc, uint32_t type,
49 		struct bnxt_ring *ring, int cmpl_ring_id);
50 int bnxt_hwrm_ver_get(struct bnxt_softc *softc);
51 int bnxt_hwrm_queue_qportcfg(struct bnxt_softc *softc, uint32_t path_dir);
52 int bnxt_hwrm_func_drv_rgtr(struct bnxt_softc *bp, unsigned long *bmap, int bmap_size,
53 			    bool async_only);
54 int bnxt_hwrm_func_drv_unrgtr(struct bnxt_softc *softc, bool shutdown);
55 int bnxt_hwrm_func_qcaps(struct bnxt_softc *softc);
56 int bnxt_hwrm_func_qcfg(struct bnxt_softc *softc);
57 int bnxt_hwrm_func_reset(struct bnxt_softc *softc);
58 int bnxt_hwrm_set_link_setting(struct bnxt_softc *softc, bool set_pause,
59     bool set_eee, bool set_link);
60 int bnxt_hwrm_set_pause(struct bnxt_softc *softc);
61 int bnxt_hwrm_vnic_ctx_alloc(struct bnxt_softc *softc, uint16_t *ctx_id);
62 int bnxt_hwrm_vnic_ctx_free(struct bnxt_softc *softc, uint16_t ctx_id);
63 int bnxt_hwrm_vnic_set_hds(struct bnxt_softc *sc, struct bnxt_vnic_info *vnic);
64 int bnxt_hwrm_vnic_cfg(struct bnxt_softc *softc, struct bnxt_vnic_info *vnic);
65 int bnxt_hwrm_vnic_alloc(struct bnxt_softc *softc, struct bnxt_vnic_info *vnic);
66 int bnxt_hwrm_vnic_free(struct bnxt_softc *softc, struct bnxt_vnic_info *vnic);
67 int bnxt_hwrm_stat_ctx_alloc(struct bnxt_softc *softc, struct bnxt_cp_ring *cpr,
68     uint64_t paddr);
69 int bnxt_hwrm_stat_ctx_free(struct bnxt_softc *softc, struct bnxt_cp_ring *cpr);
70 int bnxt_hwrm_port_qstats(struct bnxt_softc *softc);
71 int bnxt_hwrm_port_qstats_ext(struct bnxt_softc *softc);
72 int bnxt_hwrm_ring_grp_alloc(struct bnxt_softc *softc,
73     struct bnxt_grp_info *grp);
74 int bnxt_hwrm_ring_grp_free(struct bnxt_softc *softc, struct bnxt_grp_info *gr);
75 int bnxt_hwrm_cfa_l2_set_rx_mask(struct bnxt_softc *softc,
76     struct bnxt_vnic_info *vnic);
77 int bnxt_hwrm_set_filter(struct bnxt_softc *softc);
78 int bnxt_hwrm_free_filter(struct bnxt_softc *softc);
79 int bnxt_hwrm_l2_filter_alloc(struct bnxt_softc *softc, uint16_t vlan_tag,
80 		uint64_t *filter_id);
81 int bnxt_hwrm_l2_filter_free(struct bnxt_softc *softc, uint64_t filter_id);
82 int bnxt_hwrm_rss_cfg(struct bnxt_softc *softc, struct bnxt_vnic_info *vnic,
83     uint32_t hash_type);
84 int bnxt_cfg_async_cr(struct bnxt_softc *softc);
85 int bnxt_hwrm_vnic_tpa_cfg(struct bnxt_softc *softc);
86 void bnxt_validate_hw_lro_settings(struct bnxt_softc *softc);
87 int bnxt_hwrm_nvm_find_dir_entry(struct bnxt_softc *softc, uint16_t type,
88     uint16_t *ordinal, uint16_t ext, uint16_t *index, bool use_index,
89     uint8_t search_opt, uint32_t *data_length, uint32_t *item_length,
90     uint32_t *fw_ver);
91 int bnxt_hwrm_nvm_read(struct bnxt_softc *softc, uint16_t index,
92     uint32_t offset, uint32_t length, struct iflib_dma_info *data);
93 int bnxt_hwrm_nvm_modify(struct bnxt_softc *softc, uint16_t index,
94     uint32_t offset, void *data, bool cpyin, uint32_t length);
95 int bnxt_hwrm_fw_reset(struct bnxt_softc *softc, uint8_t processor,
96     uint8_t *selfreset);
97 int bnxt_hwrm_fw_qstatus(struct bnxt_softc *softc, uint8_t type,
98     uint8_t *selfreset);
99 int bnxt_hwrm_nvm_write(struct bnxt_softc *softc, void *data, bool cpyin,
100     uint16_t type, uint16_t ordinal, uint16_t ext, uint16_t attr,
101     uint16_t option, uint32_t data_length, bool keep, uint32_t *item_length,
102     uint16_t *index);
103 int bnxt_hwrm_nvm_erase_dir_entry(struct bnxt_softc *softc, uint16_t index);
104 int bnxt_hwrm_nvm_get_dir_info(struct bnxt_softc *softc, uint32_t *entries,
105     uint32_t *entry_length);
106 int bnxt_hwrm_nvm_get_dir_entries(struct bnxt_softc *softc,
107     uint32_t *entries, uint32_t *entry_length, struct iflib_dma_info *dma_data);
108 int bnxt_hwrm_nvm_get_dev_info(struct bnxt_softc *softc, uint16_t *mfg_id,
109     uint16_t *device_id, uint32_t *sector_size, uint32_t *nvram_size,
110     uint32_t *reserved_size, uint32_t *available_size);
111 int bnxt_hwrm_nvm_install_update(struct bnxt_softc *softc,
112     uint32_t install_type, uint64_t *installed_items, uint8_t *result,
113     uint8_t *problem_item, uint8_t *reset_required);
114 int bnxt_hwrm_nvm_verify_update(struct bnxt_softc *softc, uint16_t type,
115     uint16_t ordinal, uint16_t ext);
116 int bnxt_hwrm_fw_get_time(struct bnxt_softc *softc, uint16_t *year,
117     uint8_t *month, uint8_t *day, uint8_t *hour, uint8_t *minute,
118     uint8_t *second, uint16_t *millisecond, uint16_t *zone);
119 int bnxt_hwrm_fw_set_time(struct bnxt_softc *softc, uint16_t year,
120     uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second,
121     uint16_t millisecond, uint16_t zone);
122 int bnxt_hwrm_port_phy_qcfg(struct bnxt_softc *softc);
123 int bnxt_hwrm_phy_qcaps(struct bnxt_softc *softc);
124 uint16_t bnxt_hwrm_get_wol_fltrs(struct bnxt_softc *softc, uint16_t handle);
125 int bnxt_hwrm_alloc_wol_fltr(struct bnxt_softc *softc);
126 int bnxt_hwrm_free_wol_fltr(struct bnxt_softc *softc);
127 int bnxt_hwrm_set_coal(struct bnxt_softc *softc);
128 int bnxt_hwrm_func_rgtr_async_events(struct bnxt_softc *softc, unsigned long *bmap,
129 				     int bmap_size);
130 int bnxt_hwrm_func_backing_store_qcaps(struct bnxt_softc *softc);
131 int bnxt_hwrm_func_backing_store_cfg(struct bnxt_softc *softc, uint32_t);
132 int bnxt_hwrm_func_backing_store_cfg_v2(struct bnxt_softc *softc,
133 					struct bnxt_ctx_mem_type *ctxm,
134 					bool last);
135 int bnxt_hwrm_func_resc_qcaps(struct bnxt_softc *softc, bool all);
136 int bnxt_hwrm_reserve_pf_rings (struct bnxt_softc *softc);
137 void bnxt_hwrm_ring_info_get(struct bnxt_softc *softc, uint8_t ring_type,
138 			     uint32_t ring_id, uint32_t *prod, uint32_t *);
139 int bnxt_hwrm_passthrough(struct bnxt_softc *softc, void *req, uint32_t req_len,
140 			  void *resp, uint32_t resp_len, uint32_t timeout);
141 int	_hwrm_send_message(struct bnxt_softc *, void *, uint32_t);
142 int	hwrm_send_message(struct bnxt_softc *, void *, uint32_t);
143 void	bnxt_hwrm_cmd_hdr_init(struct bnxt_softc *, void *, uint16_t);
144 #endif
145