ONLP
Open Network Linux Platform APIs
Functions

Functions

const char * onlp_platformi_get (void)
 Return the name of the the platform implementation. More...
 
int onlp_platformi_set (const char *platform)
 Set the platform explicitly if necessary. More...
 
int onlp_platformi_sw_init (void)
 Initialize the platform software module. More...
 
int onlp_platformi_hw_init (uint32_t flags)
 Platform module hardware initialization. More...
 
int onlp_platformi_manage_init (void)
 Initialize the platform manager features.
 
int onlp_platformi_manage_fans (void)
 Perform necessary platform fan management. More...
 
int onlp_platformi_manage_leds (void)
 Perform necessary platform LED management. More...
 

Detailed Description

Function Documentation

◆ onlp_platformi_get()

const char* onlp_platformi_get ( void  )

Return the name of the the platform implementation.

Note
This will be called prior to any other calls into the platform driver, including the onlp_platformi_sw_init() function below.

The platform implementation name should match the current ONLP platform name.

IF the platform implementation name equals the current platform name, initialization will continue.

If the platform implementation name does not match, the following will be attempted:

onlp_platformi_set(current_platform_name); If this call is successful, initialization will continue. If this call fails, platform initialization will abort().

The onlp_platformi_set() function is optional. The onlp_platformi_get() is not optional.

◆ onlp_platformi_hw_init()

int onlp_platformi_hw_init ( uint32_t  flags)

Platform module hardware initialization.

Parameters
flagsThe initialization flags.

◆ onlp_platformi_manage_fans()

int onlp_platformi_manage_fans ( void  )

Perform necessary platform fan management.

Note
This function should automatically adjust the FAN speeds according to the platform conditions.

◆ onlp_platformi_manage_leds()

int onlp_platformi_manage_leds ( void  )

Perform necessary platform LED management.

Note
This function should automatically adjust the LED indicators according to the platform conditions.

◆ onlp_platformi_set()

int onlp_platformi_set ( const char *  platform)

Set the platform explicitly if necessary.

Parameters
platformThe platform name.

◆ onlp_platformi_sw_init()

int onlp_platformi_sw_init ( void  )

Initialize the platform software module.

Note
This should not touch the hardware.