Changeset 1927

Show
Ignore:
Timestamp:
11/11/08 19:31:59 (2 months ago)
Author:
batt
Message:

Add some comments.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/bertos/cfg/cfg_i2c.h

    r1926 r1927  
    5555 * I2C_BACKEND_BUILTIN: Use (if present) the builtin i2c hardware. 
    5656 * I2C_BACKEND_BITBANG: Use the emulated bitbang driver. 
     57 * \see drv/i2c.h for more information. 
    5758 */ 
    5859#define CONFIG_I2C_BACKEND I2C_BACKEND_BUILTIN 
  • trunk/bertos/drv/i2c.h

    r1926 r1927  
    4646/** 
    4747 * I2C Backends. 
     48 * Sometimes your cpu does not have a builtin 
     49 * i2c driver or you don't want, for some reason, to 
     50 * use that. 
     51 * You can choose, at compile time, which backend to use. 
    4852 * \{ 
    4953 */ 
     
    5256/*\}*/ 
    5357 
     58 
     59/** 
     60 * I2c builtin prototypes. 
     61 * Do NOT use these function directly, instead, 
     62 * you can call the ones named without "_builtin_" 
     63 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND) 
     64 * that you want the builtin backend. 
     65 * \{ 
     66 */ 
    5467void i2c_builtin_init(void); 
    5568bool i2c_builtin_start_w(uint8_t id); 
     
    5871bool i2c_builtin_put(uint8_t _data); 
    5972int i2c_builtin_get(bool ack); 
     73/*\}*/ 
    6074 
     75/** 
     76 * I2c bitbang prototypes. 
     77 * Same thing here: do NOT use these function directly, instead, 
     78 * you can call the ones named without "_bitbang_" 
     79 * and specify in cfg_i2c.h ( \see CONFIG_I2C_BACKEND) 
     80 * that you want the bitbang backend. 
     81 * \{ 
     82 */ 
    6183void i2c_bitbang_init(void); 
    6284bool i2c_bitbang_start_w(uint8_t id); 
     
    6587bool i2c_bitbang_put(uint8_t _data); 
    6688int i2c_bitbang_get(bool ack); 
    67  
     89/*\}*/ 
    6890 
    6991#if CONFIG_I2C_BACKEND == I2C_BACKEND_BUILTIN