xref: /freebsd/sys/dev/e1000/e1000_i210.h (revision 7609433eb60b1aee7ac039dc519e8293262f4013)
1ab5d0362SJack F Vogel /******************************************************************************
2ab5d0362SJack F Vogel 
36ab6bfe3SJack F Vogel   Copyright (c) 2001-2013, Intel Corporation
4ab5d0362SJack F Vogel   All rights reserved.
5ab5d0362SJack F Vogel 
6ab5d0362SJack F Vogel   Redistribution and use in source and binary forms, with or without
7ab5d0362SJack F Vogel   modification, are permitted provided that the following conditions are met:
8ab5d0362SJack F Vogel 
9ab5d0362SJack F Vogel    1. Redistributions of source code must retain the above copyright notice,
10ab5d0362SJack F Vogel       this list of conditions and the following disclaimer.
11ab5d0362SJack F Vogel 
12ab5d0362SJack F Vogel    2. Redistributions in binary form must reproduce the above copyright
13ab5d0362SJack F Vogel       notice, this list of conditions and the following disclaimer in the
14ab5d0362SJack F Vogel       documentation and/or other materials provided with the distribution.
15ab5d0362SJack F Vogel 
16ab5d0362SJack F Vogel    3. Neither the name of the Intel Corporation nor the names of its
17ab5d0362SJack F Vogel       contributors may be used to endorse or promote products derived from
18ab5d0362SJack F Vogel       this software without specific prior written permission.
19ab5d0362SJack F Vogel 
20ab5d0362SJack F Vogel   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21ab5d0362SJack F Vogel   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22ab5d0362SJack F Vogel   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23ab5d0362SJack F Vogel   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24ab5d0362SJack F Vogel   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25ab5d0362SJack F Vogel   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26ab5d0362SJack F Vogel   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27ab5d0362SJack F Vogel   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28ab5d0362SJack F Vogel   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29ab5d0362SJack F Vogel   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30ab5d0362SJack F Vogel   POSSIBILITY OF SUCH DAMAGE.
31ab5d0362SJack F Vogel 
32ab5d0362SJack F Vogel ******************************************************************************/
33ab5d0362SJack F Vogel /*$FreeBSD$*/
34ab5d0362SJack F Vogel 
35ab5d0362SJack F Vogel #ifndef _E1000_I210_H_
36ab5d0362SJack F Vogel #define _E1000_I210_H_
37ab5d0362SJack F Vogel 
38*7609433eSJack F Vogel bool e1000_get_flash_presence_i210(struct e1000_hw *hw);
39ab5d0362SJack F Vogel s32 e1000_update_flash_i210(struct e1000_hw *hw);
40ab5d0362SJack F Vogel s32 e1000_update_nvm_checksum_i210(struct e1000_hw *hw);
41ab5d0362SJack F Vogel s32 e1000_validate_nvm_checksum_i210(struct e1000_hw *hw);
42ab5d0362SJack F Vogel s32 e1000_write_nvm_srwr_i210(struct e1000_hw *hw, u16 offset,
43ab5d0362SJack F Vogel 			      u16 words, u16 *data);
44ab5d0362SJack F Vogel s32 e1000_read_nvm_srrd_i210(struct e1000_hw *hw, u16 offset,
45ab5d0362SJack F Vogel 			     u16 words, u16 *data);
46ab5d0362SJack F Vogel s32 e1000_acquire_swfw_sync_i210(struct e1000_hw *hw, u16 mask);
47ab5d0362SJack F Vogel void e1000_release_swfw_sync_i210(struct e1000_hw *hw, u16 mask);
48*7609433eSJack F Vogel s32 e1000_read_xmdio_reg(struct e1000_hw *hw, u16 addr, u8 dev_addr,
49*7609433eSJack F Vogel 			 u16 *data);
50*7609433eSJack F Vogel s32 e1000_write_xmdio_reg(struct e1000_hw *hw, u16 addr, u8 dev_addr,
51*7609433eSJack F Vogel 			  u16 data);
52ab5d0362SJack F Vogel 
53ab5d0362SJack F Vogel #define E1000_STM_OPCODE		0xDB00
54ab5d0362SJack F Vogel #define E1000_EEPROM_FLASH_SIZE_WORD	0x11
55ab5d0362SJack F Vogel 
56ab5d0362SJack F Vogel #define INVM_DWORD_TO_RECORD_TYPE(invm_dword) \
57ab5d0362SJack F Vogel 	(u8)((invm_dword) & 0x7)
58ab5d0362SJack F Vogel #define INVM_DWORD_TO_WORD_ADDRESS(invm_dword) \
59ab5d0362SJack F Vogel 	(u8)(((invm_dword) & 0x0000FE00) >> 9)
60ab5d0362SJack F Vogel #define INVM_DWORD_TO_WORD_DATA(invm_dword) \
61ab5d0362SJack F Vogel 	(u16)(((invm_dword) & 0xFFFF0000) >> 16)
62ab5d0362SJack F Vogel 
63ab5d0362SJack F Vogel enum E1000_INVM_STRUCTURE_TYPE {
64ab5d0362SJack F Vogel 	E1000_INVM_UNINITIALIZED_STRUCTURE		= 0x00,
65ab5d0362SJack F Vogel 	E1000_INVM_WORD_AUTOLOAD_STRUCTURE		= 0x01,
66ab5d0362SJack F Vogel 	E1000_INVM_CSR_AUTOLOAD_STRUCTURE		= 0x02,
67ab5d0362SJack F Vogel 	E1000_INVM_PHY_REGISTER_AUTOLOAD_STRUCTURE	= 0x03,
68ab5d0362SJack F Vogel 	E1000_INVM_RSA_KEY_SHA256_STRUCTURE		= 0x04,
69ab5d0362SJack F Vogel 	E1000_INVM_INVALIDATED_STRUCTURE		= 0x0F,
70ab5d0362SJack F Vogel };
71ab5d0362SJack F Vogel 
72ab5d0362SJack F Vogel #define E1000_INVM_RSA_KEY_SHA256_DATA_SIZE_IN_DWORDS	8
73ab5d0362SJack F Vogel #define E1000_INVM_CSR_AUTOLOAD_DATA_SIZE_IN_DWORDS	1
746ab6bfe3SJack F Vogel #define E1000_INVM_ULT_BYTES_SIZE	8
756ab6bfe3SJack F Vogel #define E1000_INVM_RECORD_SIZE_IN_BYTES	4
766ab6bfe3SJack F Vogel #define E1000_INVM_VER_FIELD_ONE	0x1FF8
776ab6bfe3SJack F Vogel #define E1000_INVM_VER_FIELD_TWO	0x7FE000
786ab6bfe3SJack F Vogel #define E1000_INVM_IMGTYPE_FIELD	0x1F800000
796ab6bfe3SJack F Vogel 
806ab6bfe3SJack F Vogel #define E1000_INVM_MAJOR_MASK	0x3F0
816ab6bfe3SJack F Vogel #define E1000_INVM_MINOR_MASK	0xF
826ab6bfe3SJack F Vogel #define E1000_INVM_MAJOR_SHIFT	4
83ab5d0362SJack F Vogel 
84ab5d0362SJack F Vogel #define ID_LED_DEFAULT_I210		((ID_LED_OFF1_ON2  << 8) | \
85ab5d0362SJack F Vogel 					 (ID_LED_DEF1_DEF2 <<  4) | \
86ab5d0362SJack F Vogel 					 (ID_LED_OFF1_OFF2))
87ab5d0362SJack F Vogel #define ID_LED_DEFAULT_I210_SERDES	((ID_LED_DEF1_DEF2 << 8) | \
88ab5d0362SJack F Vogel 					 (ID_LED_DEF1_DEF2 <<  4) | \
89*7609433eSJack F Vogel 					 (ID_LED_OFF1_ON2))
90ab5d0362SJack F Vogel 
916ab6bfe3SJack F Vogel /* NVM offset defaults for I211 devices */
926ab6bfe3SJack F Vogel #define NVM_INIT_CTRL_2_DEFAULT_I211	0X7243
936ab6bfe3SJack F Vogel #define NVM_INIT_CTRL_4_DEFAULT_I211	0x00C1
946ab6bfe3SJack F Vogel #define NVM_LED_1_CFG_DEFAULT_I211	0x0184
956ab6bfe3SJack F Vogel #define NVM_LED_0_2_CFG_DEFAULT_I211	0x200C
96ab5d0362SJack F Vogel #endif
97