display.c

Go to the documentation of this file.

/***************************************************************************/
#include <stdint.h>
#include <stdbool.h>
#include <string.h>

#include "displayconfigall.h"
#include "display.h"
#include "displaybackend.h"


/*******************************************************************************
 ********************************  STATICS  ************************************
 ******************************************************************************/

/* Table of display devices. */
static DISPLAY_Device_t deviceTable[DISPLAY_DEVICES_MAX];

/* This variable keeps track of whether the DISPLAY module is initialized
   or not. */
static bool moduleInitialized = false;

/* This variable keeps track of the number of devices that have been
    registered. */
static int devicesRegistered=0;

/*
 * Table of display device driver initialization functions to be called in
 * DISPLAY_Init, the DISPLAY module init function.
 */
static pDisplayDeviceDriverInitFunction_t pDisplayDeviceDriverInitFunctions[] =
  DISPLAY_DEVICE_DRIVER_INIT_FUNCTIONS;

/*******************************************************************************
 **************************     GLOBAL FUNCTIONS      **************************
 ******************************************************************************/

/***************************************************************************/
EMSTATUS DISPLAY_Init (void)
{
  EMSTATUS status;

  pDisplayDeviceDriverInitFunction_t* pDisplayDeviceDriverInitFunction =
    pDisplayDeviceDriverInitFunctions;

  if (false == moduleInitialized)
  {
    moduleInitialized = true;
    for (; *pDisplayDeviceDriverInitFunction; pDisplayDeviceDriverInitFunction++)
    {
      status = (*pDisplayDeviceDriverInitFunction)();
      if (DISPLAY_EMSTATUS_OK != status)
        return status;
    }
  }

  return DISPLAY_EMSTATUS_OK;
}


/***************************************************************************/
EMSTATUS DISPLAY_DriverRefresh (void)
{
  int        i;
  EMSTATUS status = DISPLAY_EMSTATUS_OK;

  if (false == moduleInitialized)
  {
    status = DISPLAY_EMSTATUS_NOT_INITIALIZED;
  }
  else
  {
    for (i=0; i<devicesRegistered; i++)
    {
      if (deviceTable[i].pDriverRefresh)
      {
        status = (*deviceTable[i].pDriverRefresh)(&deviceTable[i]);
        if (DISPLAY_EMSTATUS_OK != status)
        {
          return status;
        }
      }
    }
  }

  return status;
}


/***************************************************************************/
EMSTATUS DISPLAY_DeviceGet(int                displayDeviceNo,
                           DISPLAY_Device_t*  device)
{
  EMSTATUS status;

  if (false == moduleInitialized)
  {
    status = DISPLAY_EMSTATUS_NOT_INITIALIZED;
  }
  else
  {
    if (displayDeviceNo < DISPLAY_DEVICES_MAX)
    {
      memcpy(device, &deviceTable[displayDeviceNo], sizeof(DISPLAY_Device_t));
      status = DISPLAY_EMSTATUS_OK;
    }
    else
    {
      status = DISPLAY_EMSTATUS_OUT_OF_RANGE;
    }
  }
  return status;
}


/**************************************************************************/
EMSTATUS DISPLAY_DeviceRegister(DISPLAY_Device_t *device)
{
  EMSTATUS status;

  if (false == moduleInitialized)
  {
    status = DISPLAY_EMSTATUS_NOT_INITIALIZED;
  }
  else
  {
    if (devicesRegistered < DISPLAY_DEVICES_MAX)
    {
      memcpy(&deviceTable[devicesRegistered++], device, sizeof(DISPLAY_Device_t));
      status = DISPLAY_EMSTATUS_OK;
    }
    else
    {
      status = DISPLAY_EMSTATUS_NOT_ENOUGH_MEMORY;
    }
  }
  return status;
}


/***************  THE REST OF THE FILE IS DOCUMENTATION ONLY !  ***************/

/*******************************************************************************
 **************************       DOCUMENTATION       **************************
 ******************************************************************************/

/***************************************************************************/