fani

Functions
int	onlp_fani_sw_init (void)
	Software initialization of the Fan module.
int	onlp_fani_hw_init (uint32_t flags)
	Hardware initialization of the Fan module. More...
int	onlp_fani_sw_denit (void)
	Deinitialize the fan software module. More...
int	onlp_fani_id_validate (onlp_oid_id_t id)
	Validate a fan id. More...
int	onlp_fani_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *hdr)
	Retrieve the fan's OID hdr. More...
int	onlp_fani_info_get (onlp_oid_id_t id, onlp_fan_info_t *rv)
	Get the information structure for the given fan OID. More...
int	onlp_fani_caps_get (onlp_oid_id_t id, uint32_t *rv)
	Get the fan capabilities. More...
int	onlp_fani_rpm_set (onlp_oid_id_t id, int rpm)
	Set the fan speed in RPM. More...
int	onlp_fani_percentage_set (onlp_oid_id_t id, int p)
	Set the fan speed in percentage. More...
int	onlp_fani_dir_set (onlp_oid_id_t id, onlp_fan_dir_t dir)
	Set the fan direction (if supported). More...

Detailed Description

Function Documentation

onlp_fani_caps_get()

int onlp_fani_caps_get	(	onlp_oid_id_t	id,
		uint32_t *	rv
	)

Get the fan capabilities.

Parameters

	id	The fan id.
[out]	rv	The fan capabilities

onlp_fani_dir_set()

int onlp_fani_dir_set	(	onlp_oid_id_t	id,
		onlp_fan_dir_t	dir
	)

Set the fan direction (if supported).

Parameters

id	The fan OID
dir	The direction.

onlp_fani_hdr_get()

int onlp_fani_hdr_get	(	onlp_oid_id_t	id,
		onlp_oid_hdr_t *	hdr
	)

Retrieve the fan's OID hdr.

Parameters

	id	The fan id.
[out]	hdr	Receives the OID header.

onlp_fani_hw_init()

int onlp_fani_hw_init

(

uint32_t

flags

)

Hardware initialization of the Fan module.

Parameters

flags

The hardware initialization flags.

onlp_fani_id_validate()

int onlp_fani_id_validate

(

onlp_oid_id_t

id

)

Validate a fan id.

Parameters

id	The fan id.

onlp_fani_info_get()

int onlp_fani_info_get	(	onlp_oid_id_t	id,
		onlp_fan_info_t *	rv
	)

Get the information structure for the given fan OID.

Parameters

	id	The fan id
[out]	rv	Receives the fan information.

onlp_fani_percentage_set()

int onlp_fani_percentage_set	(	onlp_oid_id_t	id,
		int	p
	)

Set the fan speed in percentage.

Parameters

id	The fan OID.
p	The new fan speed percentage.

Note

This is only relevant if the PERCENTAGE capability is set.

onlp_fani_rpm_set()

int onlp_fani_rpm_set	(	onlp_oid_id_t	id,
		int	rpm
	)

Set the fan speed in RPM.

Parameters

id	The fan OID
rpm	The new RPM

Note

This is only relevant if the RPM capability is set.

onlp_fani_sw_denit()

int onlp_fani_sw_denit

(

void

)

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