tinySA/os/hal/templates/meta/driver.h

/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
                 2011,2012,2013 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    xxx.h
 * @brief   XXX Driver macros and structures.
 *
 * @addtogroup XXX
 * @{
 */

#ifndef _XXX_H_
#define _XXX_H_

#if HAL_USE_XXX || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver constants.                                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Driver pre-compile time settings.                                         */
/*===========================================================================*/

/*===========================================================================*/
/* Derived constants and error checks.                                       */
/*===========================================================================*/

/*===========================================================================*/
/* Driver data structures and types.                                         */
/*===========================================================================*/

/**
 * @brief   Driver state machine possible states.
 */
typedef enum {
  XXX_UNINIT = 0,                   /**< Not initialized.                   */
  XXX_STOP = 1,                     /**< Stopped.                           */
  XXX_READY = 2,                    /**< Ready.                             */
} xxxstate_t;

/**
 * @brief   Type of a structure representing a XXX driver.
 */
typedef struct XXXDriver XXXDriver;

#include "xxx_lld.h"

/*===========================================================================*/
/* Driver macros.                                                            */
/*===========================================================================*/

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif
  void xxxInit(void);
  void xxxObjectInit(XXXDriver *xxxp);
  void xxxStart(XXXDriver *xxxp, const XXXConfig *config);
  void xxxStop(XXXDriver *xxxp);
#ifdef __cplusplus
}
#endif

#endif /* HAL_USE_XXX */

#endif /* _XXX_H_ */

/** @} */