ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix documentation and example

pull/8506/head
paul-szczepanek-arm 2018-10-23 12:03:59 +01:00
parent ba23fef90b
commit 52a0b649bc
1 changed files with 50 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
drivers/I2CSlave.h
View File

@ -25,38 +25,41 @@
namespace mbed { namespace mbed {
/** \addtogroup drivers */ /** \addtogroup drivers */
/** An I2C Slave, used for communicating with an I2C Master device /** An I2C Slave, used for communicating with an I2C Master device.
* *
* @note Synchronization level: Not protected * @note Synchronization level: Not protected
* *
* Example: * Example Simple I2C responder:
* @code * @code
* // Simple I2C responder
* #include <mbed.h> * #include <mbed.h>
* *
* I2CSlave slave(p9, p10); * const int SLAVE_ADDRESS = 0xA0;
* const char message[] = "Slave!";
*
* I2CSlave slave(I2C_SDA, I2C_SCL);
* *
* int main() { * int main() {
* char buf[10]; * slave.address(SLAVE_ADDRESS);
* char msg[] = "Slave!";
*
* slave.address(0xA0);
* while (1) { * while (1) {
* int i = slave.receive(); * int operation = slave.receive();
* switch (i) { * switch (operation) {
* case I2CSlave::ReadAddressed: * case I2CSlave::ReadAddressed:
* slave.write(msg, strlen(msg) + 1); // Includes null char * int status = slave.write(message, sizeof(message));
* if (status == 0) {
* printf("Written message: %s\n", message);
* } else {
* printf("Failed to write message.\n");
* }
* break; * break;
* case I2CSlave::WriteGeneral: * case I2CSlave::WriteGeneral:
* slave.read(buf, 10); * int byte_read = slave.read();
* printf("Read G: %s\n", buf); * printf("Read General: %c (%d)\n", byte_read, byte_read);
* break; * break;
* case I2CSlave::WriteAddressed: * case I2CSlave::WriteAddressed:
* slave.read(buf, 10); * int byte_read = slave.read();
* printf("Read A: %s\n", buf); * printf("Read Addressed: %c (%d)\n", byte_read, byte_read);
* break; * break;
* } * }
* for(int i = 0; i < 10; i++) buf[i] = 0; // Clear buffer
* } * }
* } * }
* @endcode * @endcode
@ -74,71 +77,71 @@ public:
/** Create an I2C Slave interface, connected to the specified pins. /** Create an I2C Slave interface, connected to the specified pins.
* *
* @param sda I2C data line pin * @param sda I2C data line pin.
* @param scl I2C clock line pin * @param scl I2C clock line pin.
*/ */
I2CSlave(PinName sda, PinName scl); I2CSlave(PinName sda, PinName scl);
/** Set the frequency of the I2C interface /** Set the frequency of the I2C interface.
* *
* @param hz The bus frequency in hertz * @param hz The bus frequency in Hertz.
*/ */
void frequency(int hz); void frequency(int hz);
/** Checks to see if this I2C Slave has been addressed. /** Check if this I2C Slave has been addressed.
* *
* @returns * @return A status indicating if the device has been addressed and how.
* A status indicating if the device has been addressed, and how * @retval NoData The slave has not been addressed.
* - NoData - the slave has not been addressed * @retval ReadAddressed The master has requested a read from this slave.
* - ReadAddressed - the master has requested a read from this slave * @retval WriteAddressed The master is writing to this slave.
* - WriteAddressed - the master is writing to this slave * @retval WriteGeneral The master is writing to all slave.
* - WriteGeneral - the master is writing to all slave
*/ */
int receive(void); int receive(void);
/** Read from an I2C master. /** Read specified number of bytes from an I2C master.
* *
* @param data pointer to the byte array to read data in to * @param data Pointer to the buffer to read data into.
* @param length maximum number of bytes to read * @param length Number of bytes to read.
* *
* @returns * @return Result of the operation.
* 0 on success, * @retval 0 If the number of bytes read is equal to length requested.
* non-0 otherwise * @retval nonzero On error or if the number of bytes read is less than requested.
*/ */
int read(char *data, int length); int read(char *data, int length);
/** Read a single byte from an I2C master. /** Read a single byte from an I2C master.
* *
* @returns * @return The byte read.
* the byte read
*/ */
int read(void); int read(void);
/** Write to an I2C master. /** Write to an I2C master.
* *
* @param data pointer to the byte array to be transmitted * @param data Pointer to the buffer containing the data to be sent.
* @param length the number of bytes to transmite * @param length Number of bytes to send.
* *
* @returns * @return
* 0 on success, * @retval 0 If written all bytes successfully.
* non-0 otherwise * @retval nonzero On error or if the number of bytes written is less than requested.
*/ */
int write(const char *data, int length); int write(const char *data, int length);
/** Write a single byte to an I2C master. /** Write a single byte to an I2C master.
* *
* @param data the byte to write * @param data Value to write.
* *
* @returns * @return Result of the operation.
* '1' if an ACK was received, * @retval 0 If an NACK was received.
* '0' otherwise * @retval 1 If an ACK was received.
* @retval 2 On timeout.
*/ */
int write(int data); int write(int data);
/** Sets the I2C slave address. /** Set the I2C slave address.
* *
* @param address The address to set for the slave (ignoring the least * @param address The address to set for the slave (least significant bit is ignored).
* signifcant bit). If set to 0, the slave will only respond to the *
* @note If address is set to 0, the slave will only respond to the
* general call address. * general call address.
*/ */
void address(int address); void address(int address);