PDK API Guide for AM65xx
icssg_stats_priv.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2021
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the
14  * distribution.
15  *
16  * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
40 #ifndef ICSSG_STATS_PRIV_H_
41 #define ICSSG_STATS_PRIV_H_
42 
43 /* ========================================================================== */
44 /* Include Files */
45 /* ========================================================================== */
46 
47 #include <stdint.h>
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 /* ========================================================================== */
55 /* Macros */
56 /* ========================================================================== */
57 
58 /* None */
59 
60 /* ========================================================================== */
61 /* Structures and Enums */
62 /* ========================================================================== */
63 
67 typedef struct IcssgStats_Obj_s
68 {
71 
73  uintptr_t port1Addr;
74 
76  uintptr_t port2Addr;
77 
79  uintptr_t paStatsAddr;
81 
85 typedef struct IcssgStats_Obj_s *IcssgStats_Handle;
86 
87 /* ========================================================================== */
88 /* Global Variables Declarations */
89 /* ========================================================================== */
90 
91 /* None */
92 
93 /* ========================================================================== */
94 /* Function Declarations */
95 /* ========================================================================== */
96 
111 int32_t IcssgStats_open(EnetMod_Handle hMod,
112  Enet_Type enetType,
113  uint32_t instId,
114  const void *cfg,
115  uint32_t cfgSize);
116 
128 int32_t IcssgStats_rejoin(EnetMod_Handle hMod,
129  Enet_Type enetType,
130  uint32_t instId);
131 
143 int32_t IcssgStats_ioctl(EnetMod_Handle hMod,
144  uint32_t cmd,
145  Enet_IoctlPrms *prms);
146 
153 
154 /* ========================================================================== */
155 /* Deprecated Function Declarations */
156 /* ========================================================================== */
157 
158 /* None */
159 
160 /* ========================================================================== */
161 /* Static Function Definitions */
162 /* ========================================================================== */
163 
164 /* None */
165 
166 #ifdef __cplusplus
167 }
168 #endif
169 
170 #endif /* ICSSG_STATS_PRIV_H_ */
Enet_Type
Ethernet peripheral type.
Definition: enet_types.h:195
int32_t IcssgStats_rejoin(EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId)
Rejoin a running ICSSG Stats module.
void IcssgStats_close(EnetMod_Handle hMod)
Close ICSSG Stats module.
Ethernet Module object.
Definition: enet_mod.h:136
uintptr_t port2Addr
Definition: icssg_stats_priv.h:76
int32_t IcssgStats_ioctl(EnetMod_Handle hMod, uint32_t cmd, Enet_IoctlPrms *prms)
Run an IOCTL operation on the ICSSG Stats module.
uintptr_t paStatsAddr
Definition: icssg_stats_priv.h:79
struct IcssgStats_Obj_s * IcssgStats_Handle
ICSSG Statistics handle.
Definition: icssg_stats_priv.h:85
Enet IOCTL param.
Definition: enet_ioctl.h:229
This file contains the type definitions and helper macros for ICSSG Statistics interface.
uintptr_t port1Addr
Definition: icssg_stats_priv.h:73
ICSSG Statistics object.
Definition: icssg_stats_priv.h:67
struct EnetMod_Obj_s * EnetMod_Handle
Ethernet Module handle.
Definition: enet_mod.h:71
EnetMod_Obj enetMod
Definition: icssg_stats_priv.h:70
int32_t IcssgStats_open(EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId, const void *cfg, uint32_t cfgSize)
Open and initialize Stats module.