e1000_nvm.h revision 176667
1255829Sdes/*******************************************************************************
2255829Sdes
3255829Sdes  Copyright (c) 2001-2008, Intel Corporation
4255829Sdes  All rights reserved.
5255829Sdes
6255829Sdes  Redistribution and use in source and binary forms, with or without
7255829Sdes  modification, are permitted provided that the following conditions are met:
8255829Sdes
9255829Sdes   1. Redistributions of source code must retain the above copyright notice,
10255829Sdes      this list of conditions and the following disclaimer.
11255829Sdes
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
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31
32*******************************************************************************/
33/* $FreeBSD: head/sys/dev/em/e1000_nvm.h 176667 2008-02-29 21:50:11Z jfv $ */
34
35
36#ifndef _E1000_NVM_H_
37#define _E1000_NVM_H_
38
39s32  e1000_acquire_nvm_generic(struct e1000_hw *hw);
40
41s32  e1000_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
42s32  e1000_read_mac_addr_generic(struct e1000_hw *hw);
43s32  e1000_read_pba_num_generic(struct e1000_hw *hw, u32 *pba_num);
44s32  e1000_read_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
45s32  e1000_read_nvm_microwire(struct e1000_hw *hw, u16 offset,
46                              u16 words, u16 *data);
47s32  e1000_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words,
48                         u16 *data);
49s32  e1000_valid_led_default_generic(struct e1000_hw *hw, u16 *data);
50s32  e1000_validate_nvm_checksum_generic(struct e1000_hw *hw);
51s32  e1000_write_nvm_eewr(struct e1000_hw *hw, u16 offset,
52                          u16 words, u16 *data);
53s32  e1000_write_nvm_microwire(struct e1000_hw *hw, u16 offset,
54                               u16 words, u16 *data);
55s32  e1000_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words,
56                         u16 *data);
57s32  e1000_update_nvm_checksum_generic(struct e1000_hw *hw);
58void e1000_stop_nvm(struct e1000_hw *hw);
59void e1000_release_nvm_generic(struct e1000_hw *hw);
60void e1000_reload_nvm_generic(struct e1000_hw *hw);
61
62/* Function pointers */
63s32  e1000_acquire_nvm(struct e1000_hw *hw);
64void e1000_release_nvm(struct e1000_hw *hw);
65
66#define E1000_STM_OPCODE  0xDB00
67
68#endif
69