Choco OS  V.0.16.9.0
Join to the chocolate world
LCD TFT Driver

Common driver for LCD-TFT. More...

Functions

oC_ErrorCode_t oC_LCDTFT_TurnOn (void)
 turns on the module More...
 
oC_ErrorCode_t oC_LCDTFT_TurnOff (void)
 Turns off the LCDTFT driver. More...
 
bool oC_LCDTFT_IsTurnedOn (void)
 checks if the driver is turned on More...
 
oC_ErrorCode_t oC_LCDTFT_Configure (const oC_LCDTFT_Config_t *Config, oC_LCDTFT_Context_t *outContext)
 configures LCDTFT pins to work More...
 
oC_ErrorCode_t oC_LCDTFT_Unconfigure (const oC_LCDTFT_Config_t *Config, oC_LCDTFT_Context_t *outContext)
 Unconfigures the driver. More...
 
oC_ErrorCode_t oC_LCDTFT_Ioctl (oC_LCDTFT_Context_t Context, oC_Ioctl_Command_t Command, void *Data)
 handles input/output driver commands More...
 

Detailed Description

Function Documentation

oC_ErrorCode_t oC_LCDTFT_Configure ( const oC_LCDTFT_Config_t Config,
oC_LCDTFT_Context_t outContext 
)

The function is for configuration of the driver. Look at the oC_LCDTFT_Config_t structure description and fields list to get more info.

Parameters
ConfigPointer to the configuration structure
outContextDestination for the driver context structure
Returns
code of error

Definition at line 231 of file oc_lcdtft.c.

oC_ErrorCode_t oC_LCDTFT_Ioctl ( oC_LCDTFT_Context_t  Context,
oC_Ioctl_Command_t  Command,
void *  Data 
)

The function is for handling input/output control commands. It will be called for non-standard operations from the userspace.

Parameters
ContextContext of the driver
CommandCommand to execute
DataData for the command or NULL if not used
Returns
code of errror

Definition at line 325 of file oc_lcdtft.c.

bool oC_LCDTFT_IsTurnedOn ( void  )
Returns
true if driver is turned on

Definition at line 214 of file oc_lcdtft.c.

oC_ErrorCode_t oC_LCDTFT_TurnOff ( void  )

The function for turning off the LCDTFT driver. If the driver not started yet, it will return oC_ErrorCode_ModuleNotStartedYet error code. It also turns off the LLD.

Returns
code of error

Definition at line 187 of file oc_lcdtft.c.

oC_ErrorCode_t oC_LCDTFT_TurnOn ( void  )

The function is for turning on the LCDTFT module. If the module is already turned on, it will return oC_ErrorCode_ModuleIsTurnedOn error. It also turns on the LLD layer.

Returns
code of error

Definition at line 153 of file oc_lcdtft.c.

oC_ErrorCode_t oC_LCDTFT_Unconfigure ( const oC_LCDTFT_Config_t Config,
oC_LCDTFT_Context_t outContext 
)

The function is for reverting configuration from the oC_LCDTFT_Configure function.

Parameters
ConfigPointer to the configuration
outContextDestination for the context structure
Returns
code of error

Definition at line 286 of file oc_lcdtft.c.