ONLP
Open Network Linux Platform APIs
Macros | Functions

Macros

#define ONLP_CHASSIS_PSU_INFO_ENTRY_INIT(_id, _desc)
 Initialize a static PSU info structure. More...
 

Functions

int onlp_psui_sw_init (void)
 Software initialization of the PSU module.
 
int onlp_psui_hw_init (uint32_t flags)
 Hardware initialization of the PSU module. More...
 
int onlp_psui_sw_denit (void)
 Deinitialize the psu software module. More...
 
int onlp_psui_id_validate (onlp_oid_id_t id)
 Validate a PSU OID. More...
 
int onlp_psui_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *rv)
 Get the PSU's oid header. More...
 
int onlp_psui_info_get (onlp_oid_id_t id, onlp_psu_info_t *rv)
 Get the information structure for the given PSU. More...
 

Detailed Description

Macro Definition Documentation

◆ ONLP_CHASSIS_PSU_INFO_ENTRY_INIT

#define ONLP_CHASSIS_PSU_INFO_ENTRY_INIT (   _id,
  _desc 
)
Value:
{ \
{ \
.id = _id, \
.description = _desc, \
.poid = ONLP_OID_CHASSIS, \
}, \
}
#define ONLP_OID_CHASSIS
Definition: oids.h:260

Initialize a static PSU info structure.

Function Documentation

◆ onlp_psui_hdr_get()

int onlp_psui_hdr_get ( onlp_oid_id_t  id,
onlp_oid_hdr_t rv 
)

Get the PSU's oid header.

Parameters
idThe PSU OID.
[out]rvReceives the header.

◆ onlp_psui_hw_init()

int onlp_psui_hw_init ( uint32_t  flags)

Hardware initialization of the PSU module.

Parameters
flagsThe hardware initialization flags.

◆ onlp_psui_id_validate()

int onlp_psui_id_validate ( onlp_oid_id_t  id)

Validate a PSU OID.

Parameters
idThe id.

◆ onlp_psui_info_get()

int onlp_psui_info_get ( onlp_oid_id_t  id,
onlp_psu_info_t rv 
)

Get the information structure for the given PSU.

Parameters
idThe PSU OID
[out]rvReceives the PSU information.

◆ onlp_psui_sw_denit()

int onlp_psui_sw_denit ( void  )

Deinitialize the psu software module.

Note
The primary purpose of this API is to properly deallocate any resources used by the module in order faciliate detection of real resouce leaks.