API Reference: Libraries

 Top

pitx-sp_fan

NAME

pitx-sp_fan - fan driver for pITX-SP

ROUTINES

pitxSetFanControl( ) - Set fan control register
pitxGetFanControl( ) - Get current value of fan control register
pitxSetFanSpeed( ) - Set fan speed
pitxSetFanDivisor( ) - set fan divisor
pitxGetFanSpeedRPS( ) - Get fan speed in RPS (round per sec)
pitxGetFanSpeed( ) - Get fan speed with current divisor

DESCRIPTION

Driver for pITX-SP fan. For details see: KTD-S0003-C pITX-SP Software Guide

API Reference: Routines

 Top

pitxSetFanControl( )

NAME

pitxSetFanControl( ) - Set fan control register

SYNOPSIS

void pitxSetFanControl(UINT8 bitMap)

DESCRIPTION

This function sets the Fan control register with a new value

PARAMETERS

bitMap - new value of the control register

RETURNS

N/A

ERRNO

SEE ALSO

pitx

API Reference: Routines

 Top

pitxGetFanControl( )

NAME

pitxGetFanControl( ) - Get current value of fan control register

SYNOPSIS

void pitxGetFanControl(UINT8 *pFanCtrl)

DESCRIPTION

This function returns the current value of the Fan control register

PARAMETERS

pFanCtrl - output parameter

RETURNS

N/A

ERRNO

SEE ALSO

pitx

API Reference: Routines

 Top

pitxSetFanSpeed( )

NAME

pitxSetFanSpeed( ) - Set fan speed

SYNOPSIS

void pitxSetFanSpeed(UINT8 speed)

DESCRIPTION

This function sets a value of fan speed. The fan speed can be specified by the value from 0 to 31.

PARAMETERS

speed - desired speed of a fan (0

minimum; 31 maximum speed)

RETURNS

N/A

ERRNO

SEE ALSO

pitx

API Reference: Routines

 Top

pitxSetFanDivisor( )

NAME

pitxSetFanDivisor( ) - set fan divisor

SYNOPSIS

void pitxSetFanDivisor(UINT8 div)

DESCRIPTION

This function sets a divisor for the fan speed

PARAMETERS

div - value for the divisor (0 ~ 3)

RETURNS

N/A

ERRNO

SEE ALSO

pitx

API Reference: Routines

 Top

pitxGetFanSpeedRPS( )

NAME

pitxGetFanSpeedRPS( ) - Get fan speed in RPS (round per sec)

SYNOPSIS

void pitxGetFanSpeedRPS(UINT8 *pSpeed)

DESCRIPTION

This function returns the current speed of a fan in RPS. To get the correct result in RPS, the function tries different values of divisor. The routine can take several seconds to complete.

PARAMETERS

pSpeed - speed output value

RETURNS

N/A

ERRNO

SEE ALSO

pitx

API Reference: Routines

 Top

pitxGetFanSpeed( )

NAME

pitxGetFanSpeed( ) - Get fan speed with current divisor

SYNOPSIS

void pitxGetFanSpeed(UINT8 *pSpeed)

DESCRIPTION

This function returns the current value of the speed register. The real speed should be calculated using the current value of the divisor.

PARAMETERS

pSpeed - speed output value

RETURNS

N/A

ERRNO

SEE ALSO

pitx