Modules

Data Structures
struct	onlp_module_info_s
	Module OID Information Structure. More...

Typedefs
typedef struct onlp_module_info_s	onlp_module_info_t
	Module OID Information Structure.

Functions
int	onlp_module_sw_init (void)
	Initialize the module software module. More...
int	onlp_module_hw_init (uint32_t flags)
	Initialize the module. More...
int	onlp_module_sw_denit (void)
	Deinitialize the module software module. More...
int	onlp_module_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *hdr)
	Get the module header structure. More...
int	onlp_module_info_get (onlp_oid_t oid, onlp_module_info_t *info)
	Get the module info structure. More...
int	onlp_module_info_to_user_json (onlp_module_info_t *info, cJSON **rv, uint32_t flags)
	Convert a module info structure to user JSON. More...
int	onlp_module_info_to_json (onlp_module_info_t *info, cJSON **rv, uint32_t flags)
	Convert a module info structure to JSON. More...
int	onlp_module_info_from_json (cJSON *cj, onlp_module_info_t *info)
	Convert a JSON object to a module info structure. More...

Detailed Description

Function Documentation

onlp_module_hdr_get()

int onlp_module_hdr_get	(	onlp_oid_t	oid,
		onlp_oid_hdr_t *	hdr
	)

Get the module header structure.

Parameters

	oid	The Module oid.
[out]	hdr	Receives the header.

onlp_module_hw_init()

int onlp_module_hw_init

(

uint32_t

flags

)

Initialize the module.

Parameters

flags

The initialization flags.

onlp_module_info_from_json()

int onlp_module_info_from_json	(	cJSON *	cj,
		onlp_module_info_t *	info
	)

Convert a JSON object to a module info structure.

Parameters

	cj	The JSON object.
[out]	info	Receives the module info structure.

onlp_module_info_get()

int onlp_module_info_get	(	onlp_oid_t	oid,
		onlp_module_info_t *	info
	)

Get the module info structure.

Parameters

	oid	The Module oid.
[out]	info

onlp_module_info_to_json()

int onlp_module_info_to_json	(	onlp_module_info_t *	info,
		cJSON **	rv,
		uint32_t	flags
	)

Convert a module info structure to JSON.

Parameters

	info	The module info structure.
[out]	rv	Receives the JSON object.
	flags	The JSON format flags.

onlp_module_info_to_user_json()

int onlp_module_info_to_user_json	(	onlp_module_info_t *	info,
		cJSON **	rv,
		uint32_t	flags
	)

Convert a module info structure to user JSON.

Parameters

	info	The module info structure.
[out]	rv	Receives the JSON object.
	flags	The JSON format flags.

onlp_module_sw_denit()

int onlp_module_sw_denit

(

void

)

Deinitialize the module 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.

onlp_module_sw_init()

int onlp_module_sw_init

(

void

)

Initialize the module software module.

Note

This will be called at software initialization time. This should not initialize any hardware.