net/hns3: fix typos on comments
[dpdk.git] / drivers / net / txgbe / base / txgbe_eeprom.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2020
3  */
4
5 #ifndef _TXGBE_EEPROM_H_
6 #define _TXGBE_EEPROM_H_
7
8 /* Checksum and EEPROM pointers */
9 #define TXGBE_PBANUM_PTR_GUARD          0xFAFA
10 #define TXGBE_EEPROM_SUM                0xBABA
11
12 #define TXGBE_FW_VER_LEN        32
13 #define TXGBE_FW_N_TXEQ         0x0002000A
14
15 #define TXGBE_FW_PTR                    0x0F
16 #define TXGBE_PBANUM0_PTR               0x05
17 #define TXGBE_PBANUM1_PTR               0x06
18 #define TXGBE_SW_REGION_PTR             0x1C
19
20 #define TXGBE_EE_CSUM_MAX               0x800
21 #define TXGBE_EEPROM_CHECKSUM           0x2F
22
23 #define TXGBE_SAN_MAC_ADDR_PTR          0x18
24 #define TXGBE_DEVICE_CAPS               0x1C
25 #define TXGBE_EEPROM_VERSION_L          0x1D
26 #define TXGBE_EEPROM_VERSION_H          0x1E
27 #define TXGBE_ISCSI_BOOT_CONFIG         0x07
28
29 #define TXGBE_SAN_MAC_ADDR_PORT0_OFFSET         0x0
30 #define TXGBE_SAN_MAC_ADDR_PORT1_OFFSET         0x3
31 #define TXGBE_DEVICE_CAPS_ALLOW_ANY_SFP         0x1
32 #define TXGBE_DEVICE_CAPS_NO_CROSSTALK_WR       (1 << 7)
33 #define TXGBE_FW_LESM_PARAMETERS_PTR            0x2
34 #define TXGBE_FW_LESM_STATE_1                   0x1
35 #define TXGBE_FW_LESM_STATE_ENABLED             0x8000 /* LESM Enable bit */
36 #define TXGBE_ALT_SAN_MAC_ADDR_BLK_PTR          0x27 /* Alt. SAN MAC block */
37 #define TXGBE_ALT_SAN_MAC_ADDR_CAPS_OFFSET      0x0 /* Alt SAN MAC capability */
38 #define TXGBE_ALT_SAN_MAC_ADDR_PORT0_OFFSET     0x1 /* Alt SAN MAC 0 offset */
39 #define TXGBE_ALT_SAN_MAC_ADDR_PORT1_OFFSET     0x4 /* Alt SAN MAC 1 offset */
40 #define TXGBE_ALT_SAN_MAC_ADDR_WWNN_OFFSET      0x7 /* Alt WWNN prefix offset */
41 #define TXGBE_ALT_SAN_MAC_ADDR_WWPN_OFFSET      0x8 /* Alt WWPN prefix offset */
42 #define TXGBE_ALT_SAN_MAC_ADDR_CAPS_SANMAC      0x0 /* Alt SAN MAC exists */
43 #define TXGBE_ALT_SAN_MAC_ADDR_CAPS_ALTWWN      0x1 /* Alt WWN base exists */
44
45 s32 txgbe_init_eeprom_params(struct txgbe_hw *hw);
46 s32 txgbe_calc_eeprom_checksum(struct txgbe_hw *hw);
47 s32 txgbe_validate_eeprom_checksum(struct txgbe_hw *hw, u16 *checksum_val);
48 s32 txgbe_update_eeprom_checksum(struct txgbe_hw *hw);
49 s32 txgbe_get_eeprom_semaphore(struct txgbe_hw *hw);
50 void txgbe_release_eeprom_semaphore(struct txgbe_hw *hw);
51
52 s32 txgbe_ee_read16(struct txgbe_hw *hw, u32 offset, u16 *data);
53 s32 txgbe_ee_readw_sw(struct txgbe_hw *hw, u32 offset, u16 *data);
54 s32 txgbe_ee_readw_buffer(struct txgbe_hw *hw, u32 offset, u32 words,
55                                 void *data);
56 s32 txgbe_ee_read32(struct txgbe_hw *hw, u32 addr, u32 *data);
57
58 s32 txgbe_ee_write16(struct txgbe_hw *hw, u32 offset, u16 data);
59 s32 txgbe_ee_writew_sw(struct txgbe_hw *hw, u32 offset, u16 data);
60 s32 txgbe_ee_writew_buffer(struct txgbe_hw *hw, u32 offset, u32 words,
61                                 void *data);
62 s32 txgbe_ee_write32(struct txgbe_hw *hw, u32 addr, u32 data);
63
64
65 #endif /* _TXGBE_EEPROM_H_ */