API Reference: Libraries

 Top

vxbW83627dhgK

NAME

vxbW83627dhgK - Driver for the hardware monitoring

ROUTINES

vxbW83627dhgDrvRegister( ) - register template sensor driver
W83627dhgInstInit( ) - first level initialization routine of sensor device
W83627dhgInstInit2( ) - second level initialization routine of sensor device
W83627dhgInstConnect( ) - third level initialization routine of sensor device
W83627dhgShow( ) - show routine
W83627dhgTempGet( ) - retrieve the value of the current temperature
W83627dhgTempGetMax( ) - retrieve the maximum value of the temperature
W83627dhgTempHyst( ) - retrieve temperature sensor hysteresis values
W83627dhgVoltageGet( ) - retrieve voltage values
W83627dhgFanGet( ) - retrieve fan values
W83627dhgSetFanSpeed( ) - set fan speed value
W83627dhgIODirGet( ) - retrieve GPIO direction settings
W83627dhgIODir( ) - set GPIO direction
W83627dhgIOPinsGet( ) - retrieve state of IO pins
W83627dhgIOPins( ) - set state of output IO pins
W83627dhgIOEdgeDetectGet( ) - Check edge event
W83627dhgIOTrigger( ) - Update trigger & and input filter settings
W83627dhgIOTriggerGet( ) - Get trigger & and input filter settings
W83627dhgIOInvert( ) - Set invertion for IO pins
W83627dhgIOInvertGet( ) - Get invertion for IO pins

DESCRIPTION

        This driver provides support for the Winbond W83627DHG hardware monitor.
        There are functions available to read the operating voltage of the CPU and power supply voltages of the system,
        CPU and system temperature, speed of fans, GPIO port.


API Reference: Routines

 Top

vxbW83627dhgDrvRegister( )

NAME

vxbW83627dhgDrvRegister( ) - register template sensor driver

DESCRIPTION

This routine registers the template sensor driver with the VxBus subsystem.

This routine contains the first instructions of the device driver that are ever executed within a VxWorks system. This function registers the driver with VxBus by providing pointers to the data structures listed previously. Once this step is complete, VxWorks is able to associate this driver with appropriate hardware within the system to form an instance.

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgInstInit( )

NAME

W83627dhgInstInit( ) - first level initialization routine of sensor device

DESCRIPTION

This is the function called to perform the first level initialization of the template sensor device.

NOTE

This routine is called early during system initialization, and *MUST NOT* make calls to OS facilities such as memory allocation and I/O.

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgInstInit2( )

NAME

W83627dhgInstInit2( ) - second level initialization routine of sensor device

DESCRIPTION

This routine performs the second level initialization of the sensor device.

NOTE

This routine is called later during system initialization. OS features such as memory allocation are available at this time.

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgInstConnect( )

NAME

W83627dhgInstConnect( ) - third level initialization routine of sensor device

DESCRIPTION

This is the function called to perform the third level initialization of the sensor device.

RETURNS

N/A

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgShow( )

NAME

W83627dhgShow( ) - show routine

SYNOPSIS

void W83627dhgShow (VXB_DEVICE_ID pInst)

DESCRIPTION

   This routine prints information about the instance to the system
   console.  This is integrated with vxBusShow.

PARAMETERS

   pInst - device identifier

RETURNS

0, always

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgTempGet( )

NAME

W83627dhgTempGet( ) - retrieve the value of the current temperature

SYNOPSIS

LOCAL STATUS W83627dhgTempGet ( VXB_DEVICE_ID pInst, INT8* sysTemp, double* cpuTemp, double* auxTemp )

DESCRIPTION

   This function retrives current temperature values for system, CPU and auxiliary device

PARAMETERS

   VXB_DEVICE_ID pInst    - device identifier 
   INT8*                 sysTemp  - system current temperature
   double*            cpuTemp - CPU current temperature
   double*            auxTemp - auxiliary device current temperature

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgTempGetMax( )

NAME

W83627dhgTempGetMax( ) - retrieve the maximum value of the temperature

SYNOPSIS

LOCAL STATUS W83627dhgTempMax ( VXB_DEVICE_ID pInst, INT8* sysTempMax, double* cpuTempMax, double* auxTempMax )

DESCRIPTION

   This function retrives maximum temperature values for system, CPU and auxiliary device

PARAMETERS

   VXB_DEVICE_ID pInst       - device identifier 
   INT8*                 sysTempMax  - system maximum temperature
   double*            cpuTempMax - CPU maximum temperature
   double*            auxTempMax - auxiliary device maximum temperature

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgTempHyst( )

NAME

W83627dhgTempHyst( ) - retrieve temperature sensor hysteresis values

SYNOPSIS

LOCAL STATUS W83627dhgTempHyst ( VXB_DEVICE_ID pInst, INT8* sysTempHyst, double* cpuTempHyst, double* auxTempHyst )

DESCRIPTION

   This function retrives temperature sensor hysteresis values for system, CPU and auxiliary device

PARAMETERS

   VXB_DEVICE_ID pInst       - device identifier 
   INT8*             sysTempHyst - system temperature sensor hysteresis
   double*       cpuTempHyst - CPU temperature sensor hysteresis
   double*       auxTempHyst - auxiliary device temperature sensor hysteresis

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgVoltageGet( )

NAME

W83627dhgVoltageGet( ) - retrieve voltage values

SYNOPSIS

LOCAL STATUS W83627dhgVoltageGet ( VXB_DEVICE_ID pInst, double* voltage, double* HighLimit, double* LowLimit, char* name, int n )

DESCRIPTION

   This function retrives output voltage (mV), high/low limits of output voltage (mV), output name.

PARAMETERS

  VXB_DEVICE_ID pInst    - device identifier ,
  double*             voltage    - output voltage value,
  double*             HighLimit  - output voltage high limit,
  double*             LowLimit   - output voltage low limit,
      char*           name       - output name,
      int                     n                  - output number

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgFanGet( )

NAME

W83627dhgFanGet( ) - retrieve fan values

SYNOPSIS

LOCAL STATUS W83627dhgFanGet ( VXB_DEVICE_ID pInst, UINT16* fan, UINT16* min, UINT8* div, int n )

DESCRIPTION

   This function retrives fan speed (revolution per minute), minimum fan speed, divisor

PARAMETERS

  VXB_DEVICE_ID pInst - device identifier ,
  UINT16* fan         - fan speed in revolutuion per minute,
  UINT16*     min         - minimum fan speed in revolutuion per minute,
  UINT8*  div         - fan divisor value,
      int     n           - fan number.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgSetFanSpeed( )

NAME

W83627dhgSetFanSpeed( ) - set fan speed value

SYNOPSIS

LOCAL STATUS W83627dhgSetFanSpeed ( VXB_DEVICE_ID pInst, UINT8 n, UINT8 val )

DESCRIPTION

   This function sets fan speed value (for PWM or DC mode)

PARAMETERS

  VXB_DEVICE_ID pInst     - device identifier,
      UINT8 n,                                - fan number,
      UINT8 val                           - fan speed value to set.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIODirGet( )

NAME

W83627dhgIODirGet( ) - retrieve GPIO direction settings

DESCRIPTION

   This function retrives current setting of GPIO direction
   The 8-bit result carries state of individual IO pins (bit0 - IO0, bit1 - IO1 ... bit7 - IO7)
   Value of 0 means pin is configurated as OUTPUT, 1 means INPUT

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIODir( )

NAME

W83627dhgIODir( ) - set GPIO direction

DESCRIPTION

   This function set direction of individual IO pins 
   Value of 0 corresponds to OUTPUT, 1 - INPUT

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIOPinsGet( )

NAME

W83627dhgIOPinsGet( ) - retrieve state of IO pins

DESCRIPTION

   This function retrives current state IO pins.
   Result reflect state of each pins regardless input or output it are.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIOPins( )

NAME

W83627dhgIOPins( ) - set state of output IO pins

DESCRIPTION

   This function update output pins 

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIOEdgeDetectGet( )

NAME

W83627dhgIOEdgeDetectGet( ) - Check edge event

DESCRIPTION

   This function check the register responsible for edge detection.  
   Return 1 bit if respective IO pin has changed its state. 

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIOTrigger( )

NAME

W83627dhgIOTrigger( ) - Update trigger & and input filter settings

DESCRIPTION

   This function gives effect to IO0, IO1 and IO5 only  
   2nd function argument:
      Bit 0 corresponds to IO0 Trigger type: 0 means Edge type, 1 means Level type
      Bit 1 => IO1 Trigger type
      Bit 2 => IO5 Trigger type
      Bit 4 enables IO0 input filter: 0 turn ON input de-bouncer, 1 turn OFF it
      Bit 5 => IO1 input filter
      Bit 6 => IO5 input filter

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIOTriggerGet( )

NAME

W83627dhgIOTriggerGet( ) - Get trigger & and input filter settings

DESCRIPTION

  Check W83627dhgIOTrigger( ) for details.

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIOInvert( )

NAME

W83627dhgIOInvert( ) - Set invertion for IO pins

DESCRIPTION

   This function enable/disable the invertion for IO pins regardless of its direction
   The 1 bit enable invertion for respective IO pin.  

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK


API Reference: Routines

 Top

W83627dhgIOInvertGet( )

NAME

W83627dhgIOInvertGet( ) - Get invertion for IO pins

DESCRIPTION

RETURNS

OK, or ERROR

ERRNO

Not Available

SEE ALSO

vxbW83627dhgK