PDK API Guide for AM65xx
icssg_timesync_priv.h File Reference

Introduction

This file contains the private type definitions and helper macros for the ICSSG TimeSync driver.

Go to the source code of this file.

Data Structures

struct  IcssgTimeSync_Obj
 ICSSG TimeSync object. More...
 

Typedefs

typedef struct IcssgTimeSync_Obj_s * IcssgTimeSync_Handle
 ICSSG TimeSync handle. More...
 

Functions

void IcssgTimeSync_initCfg (IcssgTimeSync_Cfg *timeSyncCfg)
 Initialize TimeSync configuration parameters. More...
 
int32_t IcssgTimeSync_open (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId, const void *cfg, uint32_t cfgSize)
 Open and initialize TimeSync module. More...
 
int32_t IcssgTimeSync_rejoin (EnetMod_Handle hMod, Enet_Type enetType, uint32_t instId)
 Rejoin a running TimeSync module. More...
 
int32_t IcssgTimeSync_ioctl (EnetMod_Handle hMod, uint32_t cmd, Enet_IoctlPrms *prms)
 Run an IOCTL operation on the TimeSync module. More...
 
void IcssgTimeSync_close (EnetMod_Handle hMod)
 Close ICSSG TimeSync module. More...
 

Typedef Documentation

◆ IcssgTimeSync_Handle

typedef struct IcssgTimeSync_Obj_s* IcssgTimeSync_Handle

ICSSG TimeSync handle.

Function Documentation

◆ IcssgTimeSync_initCfg()

void IcssgTimeSync_initCfg ( IcssgTimeSync_Cfg timeSyncCfg)

Initialize TimeSync configuration parameters.

Parameters
timeSyncCfgConfig parameters to be initialized

◆ IcssgTimeSync_open()

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

Open and initialize TimeSync module.

Opens and initializes the ICSSG TimeSync module. This functions expects a config structure of type IcssgTimeSync_Cfg, cfgSize must be passed accordingly.

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

◆ IcssgTimeSync_rejoin()

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

Rejoin a running TimeSync module.

This operation is not currently supported.

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

◆ IcssgTimeSync_ioctl()

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

Run an IOCTL operation on the TimeSync module.

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

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

◆ IcssgTimeSync_close()

void IcssgTimeSync_close ( EnetMod_Handle  hMod)

Close ICSSG TimeSync module.

Parameters
hModEnet Module handle