From 8b45c58317683148179c9964e67c8f7d0683257b Mon Sep 17 00:00:00 2001 From: gdisirio Date: Tue, 17 Aug 2010 08:50:00 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2132 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/templates/i2c_lld.c | 125 +++++++++++++++++++++++++++++++++++++++++++++ os/hal/templates/i2c_lld.h | 107 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 232 insertions(+) create mode 100644 os/hal/templates/i2c_lld.c create mode 100644 os/hal/templates/i2c_lld.h (limited to 'os/hal/templates') diff --git a/os/hal/templates/i2c_lld.c b/os/hal/templates/i2c_lld.c new file mode 100644 index 000000000..334088aeb --- /dev/null +++ b/os/hal/templates/i2c_lld.c @@ -0,0 +1,125 @@ +/* + ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 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 . +*/ + +/** + * @file templates/i2c_lld.c + * @brief I2C Driver subsystem low level driver source template. + * + * @addtogroup I2C_LLD + * @{ + */ + +#include "ch.h" +#include "hal.h" + +#if CH_HAL_USE_I2C || defined(__DOXYGEN__) + +/*===========================================================================*/ +/* Driver exported variables. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Driver local variables. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Driver local functions. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Driver interrupt handlers. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Driver exported functions. */ +/*===========================================================================*/ + +/** + * @brief Low level I2C driver initialization. + */ +void i2c_lld_init(void) { + +} + +/** + * @brief Configures and activates the I2C peripheral. + * + * @param[in] i2cp pointer to the @p I2CDriver object + */ +void i2c_lld_start(I2CDriver *i2cp) { + + if (i2cp->i2c_state == I2C_STOP) { + /* Clock activation.*/ + } + /* Configuration.*/ +} + +/** + * @brief Deactivates the I2C peripheral. + * + * @param[in] i2cp pointer to the @p I2CDriver object + */ +void i2c_lld_stop(I2CDriver *i2cp) { + +} + +/** + * @brief Initiates a master bus transaction. + * + * @param[in] i2cp pointer to the @p I2CDriver object + */ +void i2c_lld_master_start(I2CDriver *i2cp) { + +} + +/** + * @brief Terminates a master bus transaction. + * + * @param[in] i2cp pointer to the @p I2CDriver object + */ +void i2c_lld_master_stop(I2CDriver *i2cp) { + +} + +/** + * @brief Master transmission. + * + * @param[in] i2cp pointer to the @p I2CDriver object + * @param[in] n number of bytes to be transmitted + * @param[in] txbuf transmit data buffer pointer + */ +void i2c_lld_master_transmit(I2CDriver *i2cp, size_t n, + const uint8_t *txbuf) { + +} + +/** + * @brief Master receive. + * + * @param[in] i2cp pointer to the @p I2CDriver object + * @param[in] n number of bytes to be transmitted + * @param[in] rxbuf receive data buffer pointer + */ +void i2c_lld_master_receive(I2CDriver *i2cp, size_t n, uint8_t *rxbuf) { + +} + +#endif /* CH_HAL_USE_I2C */ + +/** @} */ diff --git a/os/hal/templates/i2c_lld.h b/os/hal/templates/i2c_lld.h new file mode 100644 index 000000000..250c827e5 --- /dev/null +++ b/os/hal/templates/i2c_lld.h @@ -0,0 +1,107 @@ +/* + ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 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 . +*/ + +/** + * @file templates/i2c_lld.h + * @brief I2C Driver subsystem low level driver header template. + * + * @addtogroup I2C_LLD + * @{ + */ + +#ifndef _I2C_LLD_H_ +#define _I2C_LLD_H_ + +#if CH_HAL_USE_I2C || defined(__DOXYGEN__) + +/*===========================================================================*/ +/* Driver constants. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Driver pre-compile time settings. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Derived constants and error checks. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* Driver data structures and types. */ +/*===========================================================================*/ + +/** + * @brief I2C completion callback type. + * + * @param[in] i2cp pointer to the @p I2CDriver object + * @param[in] sts operation status + */ +typedef void (*i2ccallback_t)(I2CDriver *i2cp, i2cstatus_t sts); + +/** + * @brief Driver configuration structure. + * @note It could be empty on some architectures. + */ +typedef struct { + /** @brief I2C bus bit rate.*/ + uint32_t ic_speed; + /* End of the mandatory fields.*/ +} I2CConfig; + +/** + * @brief Structure representing an I2C driver. + */ +typedef struct { + /** @brief Driver state.*/ + i2cstate_t id_state; + /** @brief Current configuration data.*/ + const I2CConfig *id_config; + /** @brief Current callback.*/ + i2ccallback_t id_callback; + /* End of the mandatory fields.*/ +} I2CDriver; + +/*===========================================================================*/ +/* Driver macros. */ +/*===========================================================================*/ + +/*===========================================================================*/ +/* External declarations. */ +/*===========================================================================*/ + +#ifdef __cplusplus +extern "C" { +#endif + void i2c_lld_init(void); + void i2c_lld_start(I2CDriver *i2cp); + void i2c_lld_stop(I2CDriver *i2cp); + void i2c_lld_master_start(I2CDriver *i2cp); + void i2c_lld_master_stop(I2CDriver *i2cp); + void i2c_lld_master_transmit(I2CDriver *i2cp, size_t n, + const uint8_t *txbuf); + void i2c_lld_master_receive(I2CDriver *i2cp, size_t n, uint8_t *rxbuf); +#ifdef __cplusplus +} +#endif + +#endif /* CH_HAL_USE_I2C */ + +#endif /* _I2C_LLD_H_ */ + +/** @} */ -- cgit v1.2.3