git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4047 35acf78f-673a-0410-8e92-d51de3d6d3f4

master
gdisirio 2012-03-17 14:21:45 +00:00
parent 093b17ed71
commit 3534921f05
4 changed files with 277 additions and 89 deletions

View File

@ -74,47 +74,31 @@ typedef struct I2SDriver I2SDriver;
* @{
*/
/**
* @brief Starts a I2S transmission.
* @details The transmission is started and it is executes until the specified
* buffer has entirely transmitted.
* @post A callback is invoked when the buffer has been fully transmitted.
*
* @param[in] i2sp pointer to the @p I2SDriver object
* @param[in] n number of samples to send
* @param[in] txbuf the pointer to the transmit buffer
*
* @iclass
*/
#define i2sStartSendOnceI(i2sp, n, txbuf) \
i2s_lld_start_send_once(i2sp, n, txbuf)
/**
* @brief Starts a continuous I2S transmission.
* @details The transmission is started and it is executes continuously
* until @p i2sStopSend() has been explicitly invoked .
* @post A callback is invoked when the buffer has been half transmitted
* and fully transmitted.
*
* @param[in] i2sp pointer to the @p I2SDriver object
* @param[in] n number of samples to send
* @param[in] txbuf the pointer to the transmit buffer
*
* @api
*/
#define i2sStartSendContinuousI(i2sp, n, txbuf) \
i2s_lld_start_send_continuous(i2sp, n, txbuf)
/**
* @brief Stops the ongoing transmission.
* @details The ongoing transmission, if any, is stopped, if the driver
* was not transmitting the function does nothing.
* @brief Starts a I2S data exchange.
*
* @param[in] i2sp pointer to the @p I2SDriver object
*
* @iclass
*/
#define i2sStopSendI(i2sp) \
i2s_lld_stop_send(i2sp)
#define i2sStartExchangeI(i2sp) { \
i2s_lld_start_exchange(i2sp); \
(i2sp)->state = I2S_ACTIVE; \
}
/**
* @brief Stops the ongoing data exchange.
* @details The ongoing data exchange, if any, is stopped, if the driver
* was not active the function does nothing.
*
* @param[in] i2sp pointer to the @p I2SDriver object
*
* @iclass
*/
#define i2sStopExchangeI(i2sp) { \
i2s_lld_stop_exchange(i2sp); \
(i2sp)->state = I2S_READY; \
}
/** @} */
/*===========================================================================*/
@ -128,13 +112,8 @@ extern "C" {
void i2sObjectInit(I2SDriver *i2sp);
void i2sStart(I2SDriver *i2sp, const I2SConfig *config);
void i2sStop(I2SDriver *i2sp);
void i2sStartSendOnce(I2SDriver *i2sp,
size_t n,
const i2ssample_t *txbuf);
void i2sStartSendContinuous(I2SDriver *i2sp,
size_t n,
const i2ssample_t *txbuf);
void i2sStopSend(I2SDriver *i2sp);
void i2sStartExchange(I2SDriver *i2sp);
void i2sStopExchange(I2SDriver *i2sp);
#ifdef __cplusplus
}
#endif

View File

@ -0,0 +1,124 @@
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012 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 templates/i2s_lld.c
* @brief I2S Driver subsystem low level driver source template.
*
* @addtogroup I2S
* @{
*/
#include "ch.h"
#include "hal.h"
#if HAL_USE_I2S || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver local definitions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported variables. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local variables. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local functions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver interrupt handlers. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported functions. */
/*===========================================================================*/
/**
* @brief Low level I2S driver initialization.
*
* @notapi
*/
void i2s_lld_init(void) {
}
/**
* @brief Configures and activates the I2S peripheral.
*
* @param[in] i2sp pointer to the @p I2SDriver object
*
* @notapi
*/
void i2s_lld_start(I2SDriver *i2sp) {
if (i2sp->state == I2S_STOP) {
/* Clock activation.*/
}
/* Configuration.*/
}
/**
* @brief Deactivates the I2S peripheral.
*
* @param[in] i2sp pointer to the @p I2SDriver object
*
* @notapi
*/
void i2s_lld_stop(I2SDriver *i2sp) {
if (i2sp->state == I2S_READY) {
/* Clock deactivation.*/
}
}
/**
* @brief Starts a I2S data exchange.
*
* @param[in] i2sp pointer to the @p I2SDriver object
*
* @notapi
*/
void i2s_lld_start_exchange(I2SDriver *i2sp) {
}
/**
* @brief Stops the ongoing data exchange.
* @details The ongoing data exchange, if any, is stopped, if the driver
* was not active the function does nothing.
*
* @param[in] i2sp pointer to the @p I2SDriver object
*
* @notapi
*/
void i2s_lld_stop_exchange(I2SDriver *i2sp) {
}
#endif /* HAL_USE_I2S */
/** @} */

View File

@ -0,0 +1,119 @@
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011,2012 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 templates/i2s_lld.h
* @brief I2S Driver subsystem low level driver header template.
*
* @addtogroup I2S
* @{
*/
#ifndef _I2S_LLD_H_
#define _I2S_LLD_H_
#if HAL_USE_I2S || defined(__DOXYGEN__)
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a structure representing an I2S driver.
*/
typedef struct I2SDriver I2SDriver;
/**
* @brief I2S notification callback type.
*
* @param[in] i2sp pointer to the @p I2SDriver object
* @param[in] buffer pointer to the buffer
* @param[in] n number of sample positions starting from @p buffer
*/
typedef void (*i2scallback_t)(I2SDriver *i2sp, void *buffer, size_t n);
/**
* @brief Driver configuration structure.
* @note It could be empty on some architectures.
*/
typedef struct {
/**
* @brief Callback function associated to the reception or @p NULL.
*/
i2scallback_t rx_cb;;
/**
* @brief Callback function associated to the transmission or @p NULL.
*/
i2scallback_t tx_cb;
/* End of the mandatory fields.*/
} I2SConfig;
/**
* @brief Structure representing an I2S driver.
*/
struct I2SDriver {
/**
* @brief Driver state.
*/
i2sstate_t state;
/**
* @brief Current configuration data.
*/
const I2SConfig *config;
/* End of the mandatory fields.*/
};
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void i2s_lld_init(void);
void i2s_lld_start(I2SDriver *i2sp);
void i2s_lld_stop(I2SDriver *i2sp);
void i2s_lld_start_exchange(I2SDriver *i2sp);
void i2s_lld_stop_exchange(I2SDriver *i2sp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_I2S */
#endif /* _I2S_LLD_H_ */
/** @} */

View File

@ -117,75 +117,41 @@ void i2sStop(I2SDriver *i2sp) {
}
/**
* @brief Starts a I2S transmission.
* @details The transmission is started and it is executes until the specified
* buffer has entirely transmitted.
* @post A callback is invoked when the buffer has been fully transmitted.
* @brief Starts a I2S data exchange.
*
* @param[in] i2sp pointer to the @p I2SDriver object
* @param[in] n number of samples to send
* @param[in] txbuf the pointer to the transmit buffer
*
* @api
*/
void i2sStartSendOnce(I2SDriver *i2sp, size_t n,
const i2ssample_t *txbuf) {
void i2sStartExchange(I2SDriver *i2sp) {
chDbgCheck((i2sp != NULL) && (n > 0) && (txbuf != NULL),
"i2sStartSendOnce");
chDbgCheck(i2sp != NULL "i2sStartExchange");
chSysLock();
chDbgAssert(i2sp->state == I2S_READY, "i2sStartSendOnce(), #1",
"not ready");
i2sStartSendOnceI(i2sp, n, txbuf);
chDbgAssert(i2sp->state == I2S_READY, "i2sStartExchange(), #1", "not ready");
i2sStartExchangeI(i2sp);
chSysUnlock();
}
/**
* @brief Starts a continuous I2S transmission.
* @details The transmission is started and it is executes continuously
* until @p i2sStopSend() has been explicitly invoked .
* @post A callback is invoked when the buffer has been half transmitted
* and fully transmitted.
*
* @param[in] i2sp pointer to the @p I2SDriver object
* @param[in] n number of samples to send
* @param[in] txbuf the pointer to the transmit buffer
*
* @api
*/
void i2sStartSendContinuous(I2SDriver *i2sp, size_t n,
const i2ssample_t *txbuf) {
chDbgCheck((i2sp != NULL) && (n > 0) && (txbuf != NULL),
"i2sStartSendContinuous");
chSysLock();
chDbgAssert(i2sp->state == I2S_READY, "i2sStartSendContinuous(), #1",
"not ready");
i2sStartSendContinuousI(i2sp, n, txbuf);
chSysUnlock();
}
/**
* @brief Stops the ongoing transmission.
* @details The ongoing transmission, if any, is stopped, if the driver
* was not transmitting the function does nothing.
* @brief Stops the ongoing data exchange.
* @details The ongoing data exchange, if any, is stopped, if the driver
* was not active the function does nothing.
*
* @param[in] i2sp pointer to the @p I2SDriver object
*
* @api
*/
void i2sStopSend(I2SDriver *i2sp) {
void i2sStopExchange(I2SDriver *i2sp) {
chDbgCheck((i2sp != NULL), "i2sStopSend");
chDbgCheck((i2sp != NULL), "i2sStopExchange");
chSysLock();
chDbgAssert((i2sp->state == I2S_READY) ||
(i2sp->state == I2S_ACTIVE) ||
(i2sp->state == I2S_COMPLETE),
"i2sStopSend(), #1", "not ready");
i2sStopSendI(i2sp);
"i2sStopExchange(), #1", "not ready");
i2sStopExchangeI(i2sp);
chSysUnlock();
}