e1000_nvm.h revision 169248 
1/*******************************************************************************
2
3  Copyright (c) 2001-2007, Intel Corporation
4  All rights reserved.
5
6  Redistribution and use in source and binary forms, with or without
7  modification, 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
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
34/*
35 * $FreeBSD: head/sys/dev/em/e1000_nvm.h 169248 2007-05-04 13:30:44Z rwatson $
36 */
37
38
39#ifndef _E1000_NVM_H_
40#define _E1000_NVM_H_
41
42#include "e1000_api.h"
43
44s32  e1000_acquire_nvm_generic(struct e1000_hw *hw);
45
46s32  e1000_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
47s32  e1000_read_mac_addr_generic(struct e1000_hw *hw);
48s32  e1000_read_part_num_generic(struct e1000_hw *hw, u32 *part_num);
49s32  e1000_read_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
50s32  e1000_read_nvm_microwire(struct e1000_hw *hw, u16 offset,
51                              u16 words, u16 *data);
52s32  e1000_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
53s32  e1000_valid_led_default_generic(struct e1000_hw *hw, u16 *data);
54s32  e1000_validate_nvm_checksum_generic(struct e1000_hw *hw);
55s32  e1000_write_nvm_eewr(struct e1000_hw *hw, u16 offset,
56                          u16 words, u16 *data);
57s32  e1000_write_nvm_microwire(struct e1000_hw *hw, u16 offset,
58                               u16 words, u16 *data);
59s32  e1000_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
60s32  e1000_update_nvm_checksum_generic(struct e1000_hw *hw);
61void e1000_stop_nvm(struct e1000_hw *hw);
62void e1000_release_nvm_generic(struct e1000_hw *hw);
63void e1000_reload_nvm_generic(struct e1000_hw *hw);
64
65/* Function pointers */
66s32  e1000_acquire_nvm(struct e1000_hw *hw);
67void e1000_release_nvm(struct e1000_hw *hw);
68
69#define E1000_STM_OPCODE  0xDB00
70
71#endif
72