andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

I2C. Doxy comments improvement. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/i2c_dev@2846 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
barthess 2011-03-27 15:58:39 +00:00
parent d16a6e24d9
commit 1ab46c6fb9
2 changed files with 81 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
os/hal/include/i2c.h
View File

@ -79,15 +79,12 @@ typedef enum {
/** /**
* @brief I2C notification callback type. * @brief I2C notification callback type.
* @details This callback invoked when byte transfer finish event generated, * @details This callback invoked when byte transfer finish event occurs,
* No matter sending or reading. This function designed * No matter sending or reading. This function designed
* for sending (re)start or stop events to I2C bus. * for sending (re)start or stop events to I2C bus from user level.
* Use "restart" boolean flag
* in I2CSlaveConfig structure for this needs.
* Each slave can (must?) have its own callback function.
* *
* If callback function is set to NULL - driver generate stop * If callback function is set to NULL - driver atomaticcaly
* condition on the bus after the transfer finish. * generate stop condition after the transfer finish.
* *
* @param[in] i2cp pointer to the @p I2CDriver object triggering the * @param[in] i2cp pointer to the @p I2CDriver object triggering the
* callback * callback
@ -115,8 +112,9 @@ typedef uint8_t i2cblock_t;
/** /**
* @brief Structure representing an I2C slave configuration. * @brief Structure representing an I2C slave configuration.
* @details TODO: write about befers * @details Each slave device has its own config structure with input and
* output buffers for temporally storing data.
*/ */
struct I2CSlaveConfig{ struct I2CSlaveConfig{
/** /**
@ -135,17 +133,17 @@ struct I2CSlaveConfig{
i2cerrorcallback_t id_err_callback; i2cerrorcallback_t id_err_callback;
/** /**
* @brief Pointer to input buffer. * @brief Receive and transmit buffers.
*/ */
i2cblock_t *rxbuf; // pointer to buffer i2cblock_t *rxbuf; /*!< Pointer to receive buffer. */
size_t rxdepth; // depth of buffer size_t rxdepth; /*!< Depth of buffer. */
size_t rxbytes; // count of bytes to sent in one transmission size_t rxbytes; /*!< Number of bytes to be receive in one transmission. */
size_t rxbufhead; // head pointer to current data byte size_t rxbufhead; /*!< Pointer to current data byte. */
i2cblock_t *txbuf; i2cblock_t *txbuf; /*!< Pointer to transmit buffer.*/
size_t txdepth; size_t txdepth; /*!< Depth of buffer. */
size_t txbytes; size_t txbytes; /*!< Number of bytes to be transmit in one transmission. */
size_t txbufhead; size_t txbufhead; /*!< Pointer to current data byte. */
/** /**
* @brief Contain slave address and some flags. * @brief Contain slave address and some flags.
@ -161,7 +159,13 @@ struct I2CSlaveConfig{
*/ */
uint16_t address; uint16_t address;
bool_t restart; // send restart if TRUE. Else sent stop event after complete data tx/rx /**
* @brief Boolean flag for dealing with start/stop conditions.
* @note This flag destined to use in callback functions. It place here
* for convenience and flexibility reasons, but you can use your
* own variable from user level code.
*/
bool_t restart;
#if I2C_USE_WAIT #if I2C_USE_WAIT

67
os/hal/platforms/STM32/i2c_lld.c
View File

@ -33,6 +33,12 @@ I2CDriver I2CD2;
/* Driver local functions. */ /* Driver local functions. */
/*===========================================================================*/ /*===========================================================================*/
/**
* @brief Interrupt service routine.
* @details This function handle all ERROR interrupt conditions.
*
* @param[in] i2cp pointer to the @p I2CDriver object
*/
static void i2c_serve_error_interrupt(I2CDriver *i2cp) { static void i2c_serve_error_interrupt(I2CDriver *i2cp) {
//TODO: more robust error handling //TODO: more robust error handling
chSysLockFromIsr(); chSysLockFromIsr();
@ -101,14 +107,20 @@ inline bool_t i2c_lld_rxbyte(I2CDriver *i2cp) {
} }
/* /**
* This function handle all regular interrupt conditions * @brief Interrupt service routine.
* @details This function handle all regular interrupt conditions.
*
* @param[in] i2cp pointer to the @p I2CDriver object
*/ */
static void i2c_serve_event_interrupt(I2CDriver *i2cp) { static void i2c_serve_event_interrupt(I2CDriver *i2cp) {
#if CH_DBG_ENABLE_CHECKS
// debug variables // debug variables
int i = 0; int i = 0;
int n = 0; int n = 0;
int m = 0; int m = 0;
#endif
/* In 10-bit addressing mode, /* In 10-bit addressing mode,
– To enter Transmitter mode, a master sends the header (11110xx0) and then the – To enter Transmitter mode, a master sends the header (11110xx0) and then the
@ -165,7 +177,7 @@ static void i2c_serve_event_interrupt(I2CDriver *i2cp) {
i2c_lld_txbyte(i2cp); // send first byte i2c_lld_txbyte(i2cp); // send first byte
return; return;
} }
else { else {// I2C is receiving data
/* In order to generate the non-acknowledge pulse after the last received /* In order to generate the non-acknowledge pulse after the last received
* data byte, the ACK bit must be cleared just after reading the second * data byte, the ACK bit must be cleared just after reading the second
* last data byte (after second last RxNE event). * last data byte (after second last RxNE event).
@ -197,22 +209,25 @@ static void i2c_serve_event_interrupt(I2CDriver *i2cp) {
i2cp->id_i2c->CR2 &= (~I2C_CR2_ITEVTEN); // disable BTF interrupt i2cp->id_i2c->CR2 &= (~I2C_CR2_ITEVTEN); // disable BTF interrupt
chSysUnlockFromIsr(); chSysUnlockFromIsr();
/* now driver is ready to generate (re)start/stop condition. /* now driver is ready to generate (re)start/stop condition.
* Callback function is good place to do that.*/ * Callback function is good place to do that. If not callback was
* set - driver only generate stop condition. */
i2cp->id_state = I2C_READY; i2cp->id_state = I2C_READY;
if (i2cp->id_slave_config->id_callback != NULL) if (i2cp->id_slave_config->id_callback != NULL)
i2cp->id_slave_config->id_callback(i2cp, i2cp->id_slave_config); i2cp->id_slave_config->id_callback(i2cp, i2cp->id_slave_config);
else /* If no callback function set - generate stop */ else /* No callback function set - generate stop */
i2c_lld_master_stop(i2cp); i2c_lld_master_stop(i2cp);
return; return;
} }
#if CH_DBG_ENABLE_CHECKS
else{ // debugging trap else{ // debugging trap
i = i2cp->id_i2c->SR1; i = i2cp->id_i2c->SR1;
n = i2cp->id_i2c->SR2; n = i2cp->id_i2c->SR2;
m = i2cp->id_i2c->CR1; m = i2cp->id_i2c->CR1;
return; while(TRUE);
} }
#endif /* CH_DBG_ENABLE_CHECKS */
} }
#if STM32_I2C_USE_I2C1 || defined(__DOXYGEN__) #if STM32_I2C_USE_I2C1 || defined(__DOXYGEN__)
@ -314,7 +329,11 @@ void i2c_lld_start(I2CDriver *i2cp) {
i2cp->id_i2c->CR1 |= 1; // enable interface i2cp->id_i2c->CR1 |= 1; // enable interface
} }
/**
* @brief Set clock speed.
*
* @param[in] i2cp pointer to the @p I2CDriver object
*/
void i2c_lld_set_clock(I2CDriver *i2cp) { void i2c_lld_set_clock(I2CDriver *i2cp) {
volatile uint16_t regCCR, regCR2, freq, clock_div; volatile uint16_t regCCR, regCR2, freq, clock_div;
volatile uint16_t pe_bit_saved; volatile uint16_t pe_bit_saved;
@ -389,6 +408,11 @@ void i2c_lld_set_clock(I2CDriver *i2cp) {
i2cp->id_i2c->CR1 |= pe_bit_saved; i2cp->id_i2c->CR1 |= pe_bit_saved;
} }
/**
* @brief Set operation mode of I2C hardware.
*
* @param[in] i2cp pointer to the @p I2CDriver object
*/
void i2c_lld_set_opmode(I2CDriver *i2cp) { void i2c_lld_set_opmode(I2CDriver *i2cp) {
I2C_opMode_t opmode = i2cp->id_config->opMode; I2C_opMode_t opmode = i2cp->id_config->opMode;
uint16_t regCR1; uint16_t regCR1;
@ -412,6 +436,11 @@ void i2c_lld_set_opmode(I2CDriver *i2cp) {
i2cp->id_i2c->CR1 = regCR1; i2cp->id_i2c->CR1 = regCR1;
} }
/**
* @brief Set own address.
*
* @param[in] i2cp pointer to the @p I2CDriver object
*/
void i2c_lld_set_own_address(I2CDriver *i2cp) { void i2c_lld_set_own_address(I2CDriver *i2cp) {
//TODO: dual address mode //TODO: dual address mode
@ -458,7 +487,11 @@ void i2c_lld_stop(I2CDriver *i2cp) {
i2cp->id_state = I2C_STOP; i2cp->id_state = I2C_STOP;
} }
/**
* @brief Generate start condition.
*
* @param[in] i2cp pointer to the @p I2CDriver object
*/
void i2c_lld_master_start(I2CDriver *i2cp){ void i2c_lld_master_start(I2CDriver *i2cp){
i2cp->id_i2c->CR1 |= I2C_CR1_START; i2cp->id_i2c->CR1 |= I2C_CR1_START;
while (i2cp->id_i2c->CR1 & I2C_CR1_START); while (i2cp->id_i2c->CR1 & I2C_CR1_START);
@ -468,12 +501,22 @@ void i2c_lld_master_start(I2CDriver *i2cp){
i2cp->id_i2c->CR2 |= I2C_CR2_ITEVTEN | I2C_CR2_ITBUFEN; i2cp->id_i2c->CR2 |= I2C_CR2_ITEVTEN | I2C_CR2_ITBUFEN;
} }
/**
* @brief Generate stop condition.
*
* @param[in] i2cp pointer to the @p I2CDriver object
*/
void i2c_lld_master_stop(I2CDriver *i2cp){ void i2c_lld_master_stop(I2CDriver *i2cp){
i2cp->id_i2c->CR1 |= I2C_CR1_STOP; i2cp->id_i2c->CR1 |= I2C_CR1_STOP;
while (i2cp->id_i2c->CR1 & I2C_CR1_STOP); while (i2cp->id_i2c->CR1 & I2C_CR1_STOP);
} }
/**
* @brief Begin data transmitting.
*
* @param[in] i2cp pointer to the @p I2CDriver object
* @param[in] i2cscfg pointer to the @p I2CSlaveConfig object
*/
void i2c_lld_master_transmit(I2CDriver *i2cp, I2CSlaveConfig *i2cscfg){ void i2c_lld_master_transmit(I2CDriver *i2cp, I2CSlaveConfig *i2cscfg){
i2cp->id_slave_config = i2cscfg; i2cp->id_slave_config = i2cscfg;
@ -483,6 +526,12 @@ void i2c_lld_master_transmit(I2CDriver *i2cp, I2CSlaveConfig *i2cscfg){
i2c_lld_master_start(i2cp); i2c_lld_master_start(i2cp);
} }
/**
* @brief Begin data receiving.
*
* @param[in] i2cp pointer to the @p I2CDriver object
* @param[in] i2cscfg pointer to the @p I2CSlaveConfig object
*/
void i2c_lld_master_receive(I2CDriver *i2cp, I2CSlaveConfig *i2cscfg){ void i2c_lld_master_receive(I2CDriver *i2cp, I2CSlaveConfig *i2cscfg){
i2cp->id_slave_config = i2cscfg; i2cp->id_slave_config = i2cscfg;