PDK API Guide for AM65xx
icssg_stats_priv.h File Reference

Introduction

This file contains internal type definitions and helper macros for the ICSSG Hardware and PA statistics.

Go to the source code of this file.

Data Structures

struct  IcssgStats_Obj
 ICSSG Statistics object. More...
 

Typedefs

typedef struct IcssgStats_Obj_s * IcssgStats_Handle
 ICSSG Statistics handle. More...
 

Functions

int32_t IcssgStats_open (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId, const void *cfg, uint32_t cfgSize)
 Open and initialize Stats module. More...
 
int32_t IcssgStats_rejoin (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId)
 Rejoin a running ICSSG Stats module. More...
 
int32_t IcssgStats_ioctl (EnetMod_Handle hMod, uint32_t cmd, Enet_IoctlPrms *prms)
 Run an IOCTL operation on the ICSSG Stats module. More...
 
void IcssgStats_close (EnetMod_Handle hMod)
 Close ICSSG Stats module. More...
 

Typedef Documentation

◆ IcssgStats_Handle

typedef struct IcssgStats_Obj_s* IcssgStats_Handle

ICSSG Statistics handle.

Function Documentation

◆ IcssgStats_open()

int32_t IcssgStats_open ( EnetMod_Handle  hMod,
Enet_Type  enetType,
uint32_t  instId,
const void *  cfg,
uint32_t  cfgSize 
)

Open and initialize Stats module.

Opens and initializes the ICSSG Stats module. It doesn't take any configuration parameters.

Parameters
hModEnet Module handle
enetTypeEnet Peripheral type
instIdEnet Peripheral instance id
cfgConfiguration parameters. Must be NULL
cfgSizeSize of the configuration parameters. Must be 0
Returns
ENET_SOK or Enet_ErrorCodes in case of any failure

◆ IcssgStats_rejoin()

int32_t IcssgStats_rejoin ( EnetMod_Handle  hMod,
Enet_Type  enetType,
uint32_t  instId 
)

Rejoin a running ICSSG Stats module.

This operation is not currently supported.

Parameters
hModEnet Module handle
enetTypeEnet Peripheral type
instIdEnet Peripheral instance id
Return values
ENET_ENOTSUPPORTED

◆ IcssgStats_ioctl()

int32_t IcssgStats_ioctl ( EnetMod_Handle  hMod,
uint32_t  cmd,
Enet_IoctlPrms prms 
)

Run an IOCTL operation on the ICSSG Stats module.

Runs a Enet Stats IOCTL operation on the ICSSG Stats module.

Parameters
hModEnet Module handle
cmdIOCTL command Id
prmsIOCTL parameters
Returns
ENET_SOK or Enet_ErrorCodes in case of any failure

◆ IcssgStats_close()

void IcssgStats_close ( EnetMod_Handle  hMod)

Close ICSSG Stats module.

Parameters
hModEnet Module handle