Data Structures | Macros | Typedefs | Functions
enet_utils.h File Reference

This file contains the type definitions and function prototypes of the Enet Utils functionality. More...

#include <stdint.h>
#include <stdbool.h>
#include <stdarg.h>
#include <ti/drv/enet/enet_cfg.h>
#include <ti/drv/enet/include/core/enet_types.h>
#include <ti/drv/enet/priv/core/enet_trace_priv.h>

Data Structures

struct  EnetUtils_Cfg_s
 Enet utils parameters. More...
 

Macros

#define container_of(ptr, type, member)
 Macro to get container structure from one of its members' addresses. More...
 
#define ENET_ARRAYSIZE(x)   (sizeof(x) / sizeof(x[0]))
 Macro to get the size of an array.
 
#define Enet_assert(cond, fmt,...)   (void)(cond)
 Assertion.
 
#define Enet_devAssert(cond, fmt,...)   (void)(cond)
 Development-time assertion.
 

Typedefs

typedef void(* Enet_Print )(const char *fmt,...)
 Info/debug print function prototype. More...
 
typedef uint64_t(* Enet_VirtToPhys )(const void *virtAddr, void *appData)
 Virtual-to-physical address translation callback function. More...
 
typedef void *(* Enet_PhysToVirt )(uint64_t phyAddr, void *appData)
 Physical-to-virtual address translation callback function. More...
 
typedef struct EnetUtils_Cfg_s EnetUtils_Cfg
 Enet utils parameters.
 

Functions

void EnetUtils_init (const EnetUtils_Cfg *cfg)
 Initialize utils module. More...
 
void EnetUtils_deinit (void)
 De-initialize utils module.
 
void EnetUtils_printf (const char *fmt,...)
 Print function. More...
 
void EnetUtils_vprintf (const char *fmt, va_list args)
 Print function for va_list. More...
 
uint32_t EnetUtils_min (uint32_t num1, uint32_t num2)
 Returns minimum of two numbers. More...
 
uint32_t EnetUtils_max (uint32_t num1, uint32_t num2)
 Returns minimum of two numbers. More...
 
void EnetUtils_delay (uint32_t delayVal)
 Busy loop for a given amount of cycles. More...
 
uint64_t EnetUtils_virtToPhys (const void *virtAddr, void *appData)
 Convert a virtual address to physical address. More...
 
void * EnetUtils_physToVirt (uint64_t physAddr, void *appData)
 Convert a physical address to virtual address. More...
 

Detailed Description

This file contains the type definitions and function prototypes of the Enet Utils functionality.

Macro Definition Documentation

#define container_of (   ptr,
  type,
  member 
)
Value:
({ \
const typeof(((type *)0)->member) * __mptr = (ptr); \
(type *)((char *)__mptr - offsetof(type, member)); \
})

Macro to get container structure from one of its members' addresses.

Typedef Documentation

typedef void*(* Enet_PhysToVirt)(uint64_t phyAddr, void *appData)

Physical-to-virtual address translation callback function.

This function is used by the driver to convert physical address to virtual address.

Parameters
phyAddrPhysical address
appDataCallback pointer passed during translation
Returns
Translated virtual address
typedef void(* Enet_Print)(const char *fmt,...)

Info/debug print function prototype.

This function is used by the driver to print info/debug messages.

Parameters
fmtFormatted string followed by variable arguments
typedef uint64_t(* Enet_VirtToPhys)(const void *virtAddr, void *appData)

Virtual-to-physical address translation callback function.

This function is used by the driver to convert virtual address to physical address.

Parameters
virtAddrVirtual address
appDataCallback pointer passed during translation
Returns
Translated physical address

Function Documentation

void EnetUtils_delay ( uint32_t  delayVal)

Busy loop for a given amount of cycles.

Parameters
delayValDelay time
void EnetUtils_init ( const EnetUtils_Cfg cfg)

Initialize utils module.

Utils module initialization function. Should be only called from the Enet top-level module.

Parameters
cfgPointer to the initialization parameters
uint32_t EnetUtils_max ( uint32_t  num1,
uint32_t  num2 
)

Returns minimum of two numbers.

Parameters
num1First number
num2Second number
Returns
Maximum number
uint32_t EnetUtils_min ( uint32_t  num1,
uint32_t  num2 
)

Returns minimum of two numbers.

Parameters
num1First number
num2Second number
Returns
Minimum number
void* EnetUtils_physToVirt ( uint64_t  physAddr,
void *  appData 
)

Convert a physical address to virtual address.

Parameters
physAddrPhysical address
appDataAuxiliary data
Returns
Virtual address
void EnetUtils_printf ( const char *  fmt,
  ... 
)

Print function.

Prints the provided formatted string.

Parameters
fmtFormatted string followed by variable arguments
uint64_t EnetUtils_virtToPhys ( const void *  virtAddr,
void *  appData 
)

Convert a virtual address to physical address.

Parameters
virtAddrVirtual address
appDataAuxiliary data
Returns
Physical address
void EnetUtils_vprintf ( const char *  fmt,
va_list  args 
)

Print function for va_list.

Prints the provided formatted string.

Parameters
fmtFormatted string
argsArg list pointing to the arguments in the format string

Copyright 2020, Texas Instruments Incorporated