hc
2024-12-19 9370bb92b2d16684ee45cf24e879c93c509162da
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Broadcom Event  protocol definitions
 *
 * Copyright (C) 1999-2017, Broadcom Corporation
 * 
 *      Unless you and Broadcom execute a separate written software license
 * agreement governing use of this software, this software is licensed to you
 * under the terms of the GNU General Public License version 2 (the "GPL"),
 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
 * following added to such license:
 * 
 *      As a special exception, the copyright holders of this software give you
 * permission to link this software with independent modules, and to copy and
 * distribute the resulting executable under terms of your choice, provided that
 * you also meet, for each linked independent module, the terms and conditions of
 * the license of that module.  An independent module is a module which is not
 * derived from this software.  The special exception does not apply to any
 * modifications of the software.
 * 
 *      Notwithstanding the above, under no circumstances may you combine this
 * software in any way with any other Broadcom software provided under a license
 * other than the GPL, without Broadcom's express prior written consent.
 *
 * Dependencies: bcmeth.h
 *
 * $Id: dnglevent.h $
 *
 * <<Broadcom-WL-IPTag/Open:>>
 *
 * -----------------------------------------------------------------------------
 *
 */
 
/*
 * Broadcom dngl Ethernet Events protocol defines
 *
 */
 
#ifndef _DNGLEVENT_H_
#define _DNGLEVENT_H_
 
#ifndef _TYPEDEFS_H_
#include <typedefs.h>
#endif
#include <bcmeth.h>
#include <ethernet.h>
 
/* This marks the start of a packed structure section. */
#include <packed_section_start.h>
#define BCM_DNGL_EVENT_MSG_VERSION        1
#define DNGL_E_RSRVD_1                0x0
#define DNGL_E_RSRVD_2                0x1
#define DNGL_E_SOCRAM_IND            0x2
typedef BWL_PRE_PACKED_STRUCT struct
{
   uint16  version; /* Current version is 1 */
   uint16  reserved; /* reserved for any future extension */
   uint16  event_type; /* DNGL_E_SOCRAM_IND */
   uint16  datalen; /* Length of the event payload */
} BWL_POST_PACKED_STRUCT bcm_dngl_event_msg_t;
 
typedef BWL_PRE_PACKED_STRUCT struct bcm_dngl_event {
   struct ether_header eth;
   bcmeth_hdr_t        bcm_hdr;
   bcm_dngl_event_msg_t      dngl_event;
   /* data portion follows */
} BWL_POST_PACKED_STRUCT bcm_dngl_event_t;
 
typedef BWL_PRE_PACKED_STRUCT struct bcm_dngl_socramind {
   uint16            tag;    /* data tag */
   uint16            length; /* data length */
   uint8            value[1]; /* data value with variable length specified by length */
} BWL_POST_PACKED_STRUCT bcm_dngl_socramind_t;
 
/* SOCRAM_IND type tags */
#define SOCRAM_IND_ASSERT_TAG        0x1
#define SOCRAM_IND_TAG_HEALTH_CHECK    0x2
/* Health check top level module tags */
typedef BWL_PRE_PACKED_STRUCT struct bcm_dngl_healthcheck {
   uint16            top_module_tag;    /* top level module tag */
   uint16            top_module_len; /* Type of PCIE issue indication */
   uint8            value[1]; /* data value with variable length specified by length */
} BWL_POST_PACKED_STRUCT bcm_dngl_healthcheck_t;
 
/* Health check top level module tags */
#define HEALTH_CHECK_TOP_LEVEL_MODULE_PCIEDEV_RTE 1
#define HEALTH_CHECK_PCIEDEV_VERSION_1    1
#define HEALTH_CHECK_PCIEDEV_FLAG_IN_D3_SHIFT    0
#define HEALTH_CHECK_PCIEDEV_FLAG_AER_SHIFT        1
#define HEALTH_CHECK_PCIEDEV_FLAG_LINKDOWN_SHIFT        2
#define HEALTH_CHECK_PCIEDEV_FLAG_MSI_INT_SHIFT            3
#define HEALTH_CHECK_PCIEDEV_FLAG_NODS_SHIFT            4
#define HEALTH_CHECK_PCIEDEV_FLAG_IN_D3    1 << HEALTH_CHECK_PCIEDEV_FLAG_IN_D3_SHIFT
#define HEALTH_CHECK_PCIEDEV_FLAG_AER    1 << HEALTH_CHECK_PCIEDEV_FLAG_AER_SHIFT
#define HEALTH_CHECK_PCIEDEV_FLAG_LINKDOWN    1 << HEALTH_CHECK_PCIEDEV_FLAG_LINKDOWN_SHIFT
#define HEALTH_CHECK_PCIEDEV_FLAG_MSI_INT    1 << HEALTH_CHECK_PCIEDEV_FLAG_MSI_INT_SHIFT
#define HEALTH_CHECK_PCIEDEV_FLAG_NODS    1 << HEALTH_CHECK_PCIEDEV_FLAG_NODS_SHIFT
/* PCIE Module TAGs */
#define HEALTH_CHECK_PCIEDEV_INDUCED_IND    0x1
#define HEALTH_CHECK_PCIEDEV_H2D_DMA_IND    0x2
#define HEALTH_CHECK_PCIEDEV_D2H_DMA_IND    0x3
#define HEALTH_CHECK_PCIEDEV_IOCTL_STALL_IND    0x4
#define HEALTH_CHECK_PCIEDEV_D3ACK_STALL_IND    0x5
#define HEALTH_CHECK_PCIEDEV_NODS_IND    0x6
#define HEALTH_CHECK_PCIEDEV_LINKSPEED_FALLBACK_IND    0x7
 
#define HC_PCIEDEV_CONFIG_REGLIST_MAX    20
typedef BWL_PRE_PACKED_STRUCT struct bcm_dngl_pcie_hc {
   uint16            version; /* HEALTH_CHECK_PCIEDEV_VERSION_1 */
   uint16            reserved;
   uint16            pcie_err_ind_type; /* PCIE Module TAGs */
   uint16            pcie_flag;
   uint32            pcie_control_reg;
   uint32            pcie_config_regs[HC_PCIEDEV_CONFIG_REGLIST_MAX];
} BWL_POST_PACKED_STRUCT bcm_dngl_pcie_hc_t;
 
/* This marks the end of a packed structure section. */
#include <packed_section_end.h>
 
#endif /* _DNGLEVENT_H_ */