156 lines
5.1 KiB
C
156 lines
5.1 KiB
C
/*******************************************************************************
|
|
*
|
|
* E M B E D D E D W I Z A R D P R O J E C T
|
|
*
|
|
* Copyright (c) TARA Systems GmbH
|
|
* written by Paul Banach and Manfred Schweyer
|
|
*
|
|
********************************************************************************
|
|
*
|
|
* This software is delivered "as is" and shows the usage of other software
|
|
* components. It is provided as an example software which is intended to be
|
|
* modified and extended according to particular requirements.
|
|
*
|
|
* TARA Systems hereby disclaims all warranties and conditions with regard to the
|
|
* software, including all implied warranties and conditions of merchantability
|
|
* and non-infringement of any third party IPR or other rights which may result
|
|
* from the use or the inability to use the software.
|
|
*
|
|
********************************************************************************
|
|
*
|
|
* DESCRIPTION:
|
|
* This file implements an interface between an Embedded Wizard generated UI
|
|
* application and a certain device. Please consider this file only as template
|
|
* that is intended to show the binding between an UI application and the
|
|
* underlying system (e.g. middleware, BSP, hardware driver, protocol, ...).
|
|
*
|
|
* This device driver is the counterpart to a device class implemented within
|
|
* your Embedded Wizard project.
|
|
*
|
|
* Feel free to adapt this file according your needs!
|
|
*
|
|
* Within this sample, we demonstrate the access to the board LED and the
|
|
* hardware button. Furthemore, the console interface is used to print a string.
|
|
*
|
|
*******************************************************************************/
|
|
|
|
#ifndef DEVICEDRIVER_H
|
|
#define DEVICEDRIVER_H
|
|
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
|
|
/*******************************************************************************
|
|
* FUNCTION:
|
|
* DeviceDriver_Initialize
|
|
*
|
|
* DESCRIPTION:
|
|
* The function DeviceDriver_Initialize() initializes the module and prepares all
|
|
* necessary things to access or communicate with the real device.
|
|
* The function has to be called from your main module, after the initialization
|
|
* of your GUI application.
|
|
*
|
|
* ARGUMENTS:
|
|
* None
|
|
*
|
|
* RETURN VALUE:
|
|
* None
|
|
*
|
|
*******************************************************************************/
|
|
void DeviceDriver_Initialize( void );
|
|
|
|
|
|
/*******************************************************************************
|
|
* FUNCTION:
|
|
* DeviceDriver_Deinitialize
|
|
*
|
|
* DESCRIPTION:
|
|
* The function DeviceDriver_Deinitialize() deinitializes the module and
|
|
* finalizes the access or communication with the real device.
|
|
* The function has to be called from your main module, before the GUI
|
|
* application will be deinitialized.
|
|
*
|
|
* ARGUMENTS:
|
|
* None
|
|
*
|
|
* RETURN VALUE:
|
|
* None
|
|
*
|
|
*******************************************************************************/
|
|
void DeviceDriver_Deinitialize( void );
|
|
|
|
|
|
/*******************************************************************************
|
|
* FUNCTION:
|
|
* DeviceDriver_ProcessData
|
|
*
|
|
* DESCRIPTION:
|
|
* The function DeviceDriver_ProcessData() is called from the main UI loop, in
|
|
* order to process data and events from your particular device.
|
|
* This function is responisble to update properties within the device class
|
|
* if the corresponding state or value of the real device has changed.
|
|
* This function is also responsible to trigger system events if necessary.
|
|
*
|
|
* ARGUMENTS:
|
|
* None
|
|
*
|
|
* RETURN VALUE:
|
|
* The function returns a non-zero value if a property has changed or if a
|
|
* system event was triggered. If nothing happens, the function returns 0.
|
|
*
|
|
*******************************************************************************/
|
|
int DeviceDriver_ProcessData( void );
|
|
|
|
|
|
/*******************************************************************************
|
|
* FUNCTION:
|
|
* DeviceDriver_SetLedStatus
|
|
*
|
|
* DESCRIPTION:
|
|
* This is a sample for a function called from the device class, when a
|
|
* property has changed. As a result, the corresponding value of the real
|
|
* device should be changed.
|
|
* In this implementation the LED is switched on or off.
|
|
*
|
|
*******************************************************************************/
|
|
void DeviceDriver_SetLedStatus( XInt32 aValue );
|
|
|
|
|
|
/*******************************************************************************
|
|
* FUNCTION:
|
|
* DeviceDriver_PrintMessage
|
|
*
|
|
* DESCRIPTION:
|
|
* This is a sample for a function that is called directly from a 'Command'
|
|
* method of the device class. As a result, the corresponding action should
|
|
* happen.
|
|
* In this implementation the given message is printed via the console interface.
|
|
*
|
|
*******************************************************************************/
|
|
void DeviceDriver_PrintMessage( XString aText );
|
|
|
|
|
|
/*******************************************************************************
|
|
* FUNCTION:
|
|
* DeviceDriver_SetTime
|
|
*
|
|
* DESCRIPTION:
|
|
* This is a sample for a function called from the device class, when the
|
|
* system time (RTC time) should be changed.
|
|
*
|
|
*******************************************************************************/
|
|
void DeviceDriver_SetTime( XUInt32 aTime );
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* DEVICEDRIVER_H */
|
|
|
|
|
|
/* msy */ |