e1000_manage.h revision 181027 
1/******************************************************************************
2
3  Copyright (c) 2001-2008, 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/*$FreeBSD: head/sys/dev/e1000/e1000_manage.h 181027 2008-07-30 21:56:53Z jfv $*/
34
35#ifndef _E1000_MANAGE_H_
36#define _E1000_MANAGE_H_
37
38bool e1000_check_mng_mode_generic(struct e1000_hw *hw);
39bool e1000_enable_tx_pkt_filtering_generic(struct e1000_hw *hw);
40s32  e1000_mng_enable_host_if_generic(struct e1000_hw *hw);
41s32  e1000_mng_host_if_write_generic(struct e1000_hw *hw, u8 *buffer,
42                                     u16 length, u16 offset, u8 *sum);
43s32  e1000_mng_write_cmd_header_generic(struct e1000_hw *hw,
44                                    struct e1000_host_mng_command_header *hdr);
45s32  e1000_mng_write_dhcp_info_generic(struct e1000_hw *hw,
46                                       u8 *buffer, u16 length);
47bool e1000_enable_mng_pass_thru(struct e1000_hw *hw);
48
49enum e1000_mng_mode {
50	e1000_mng_mode_none = 0,
51	e1000_mng_mode_asf,
52	e1000_mng_mode_pt,
53	e1000_mng_mode_ipmi,
54	e1000_mng_mode_host_if_only
55};
56
57#define E1000_FACTPS_MNGCG    0x20000000
58
59#define E1000_FWSM_MODE_MASK  0xE
60#define E1000_FWSM_MODE_SHIFT 1
61
62#define E1000_MNG_IAMT_MODE                  0x3
63#define E1000_MNG_DHCP_COOKIE_LENGTH         0x10
64#define E1000_MNG_DHCP_COOKIE_OFFSET         0x6F0
65#define E1000_MNG_DHCP_COMMAND_TIMEOUT       10
66#define E1000_MNG_DHCP_TX_PAYLOAD_CMD        64
67#define E1000_MNG_DHCP_COOKIE_STATUS_PARSING 0x1
68#define E1000_MNG_DHCP_COOKIE_STATUS_VLAN    0x2
69
70#define E1000_VFTA_ENTRY_SHIFT               5
71#define E1000_VFTA_ENTRY_MASK                0x7F
72#define E1000_VFTA_ENTRY_BIT_SHIFT_MASK      0x1F
73
74#define E1000_HI_MAX_BLOCK_BYTE_LENGTH       1792 /* Num of bytes in range */
75#define E1000_HI_MAX_BLOCK_DWORD_LENGTH      448 /* Num of dwords in range */
76#define E1000_HI_COMMAND_TIMEOUT             500 /* Process HI command limit */
77
78#define E1000_HICR_EN              0x01  /* Enable bit - RO */
79/* Driver sets this bit when done to put command in RAM */
80#define E1000_HICR_C               0x02
81#define E1000_HICR_SV              0x04  /* Status Validity */
82#define E1000_HICR_FW_RESET_ENABLE 0x40
83#define E1000_HICR_FW_RESET        0x80
84
85/* Intel(R) Active Management Technology signature */
86#define E1000_IAMT_SIGNATURE  0x544D4149
87
88#endif
89