1/*******************************************************************************
2
3Copyright (c) 2001-2015, Intel Corporation
4All rights reserved.
5
6Redistribution and use in source and binary forms, with or without
7modification, are permitted provided that the following conditions are met:
8
9 1. Redistributions of source code must retain the above copyright notice,
10    this list of conditions and the following disclaimer.
11
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 3. Neither the name of the Intel Corporation nor the names of its
17    contributors may be used to endorse or promote products derived from
18    this software without specific prior written permission.
19
20THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30POSSIBILITY OF SUCH DAMAGE.
31
32***************************************************************************/
33
34#ifndef _E1000_NVM_H_
35#define _E1000_NVM_H_
36
37struct e1000_pba {
38	u16 word[2];
39	u16 *pba_block;
40};
41
42struct e1000_fw_version {
43	u32 etrack_id;
44	u16 eep_major;
45	u16 eep_minor;
46	u16 eep_build;
47
48	u8 invm_major;
49	u8 invm_minor;
50	u8 invm_img_type;
51
52	bool or_valid;
53	u16 or_major;
54	u16 or_build;
55	u16 or_patch;
56};
57
58
59void e1000_init_nvm_ops_generic(struct e1000_hw *hw);
60s32  e1000_null_read_nvm(struct e1000_hw *hw, u16 a, u16 b, u16 *c);
61void e1000_null_nvm_generic(struct e1000_hw *hw);
62s32  e1000_null_led_default(struct e1000_hw *hw, u16 *data);
63s32  e1000_null_write_nvm(struct e1000_hw *hw, u16 a, u16 b, u16 *c);
64s32  e1000_acquire_nvm_generic(struct e1000_hw *hw);
65
66s32  e1000_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
67s32  e1000_read_mac_addr_generic(struct e1000_hw *hw);
68s32  e1000_read_pba_num_generic(struct e1000_hw *hw, u32 *pba_num);
69s32  e1000_read_pba_string_generic(struct e1000_hw *hw, u8 *pba_num,
70				   u32 pba_num_size);
71s32  e1000_read_pba_length_generic(struct e1000_hw *hw, u32 *pba_num_size);
72s32 e1000_read_pba_raw(struct e1000_hw *hw, u16 *eeprom_buf,
73		       u32 eeprom_buf_size, u16 max_pba_block_size,
74		       struct e1000_pba *pba);
75s32 e1000_write_pba_raw(struct e1000_hw *hw, u16 *eeprom_buf,
76			u32 eeprom_buf_size, struct e1000_pba *pba);
77s32 e1000_get_pba_block_size(struct e1000_hw *hw, u16 *eeprom_buf,
78			     u32 eeprom_buf_size, u16 *pba_block_size);
79s32  e1000_read_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
80s32  e1000_read_nvm_microwire(struct e1000_hw *hw, u16 offset,
81			      u16 words, u16 *data);
82s32  e1000_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words,
83			 u16 *data);
84s32  e1000_valid_led_default_generic(struct e1000_hw *hw, u16 *data);
85s32  e1000_validate_nvm_checksum_generic(struct e1000_hw *hw);
86s32  e1000_write_nvm_microwire(struct e1000_hw *hw, u16 offset,
87			       u16 words, u16 *data);
88s32  e1000_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words,
89			 u16 *data);
90s32  e1000_update_nvm_checksum_generic(struct e1000_hw *hw);
91void e1000_stop_nvm(struct e1000_hw *hw);
92void e1000_release_nvm_generic(struct e1000_hw *hw);
93void e1000_get_fw_version(struct e1000_hw *hw,
94			  struct e1000_fw_version *fw_vers);
95
96#define E1000_STM_OPCODE	0xDB00
97
98#endif
99