ST / X_NUCLEO_COMMON

Generic mbed Extensions used by STM Expansion Board Firmware Packages.

Dependents:   X_NUCLEO_IKS01A1 X_NUCLEO_6180XA1 1-DoorCloser 1-DoorCloser ... more

Fork of X_NUCLEO_COMMON by ST Expansion SW Team

Generic mbed Extensions used by STM Expansion Board Firmware Packages

DbgMCU

Helper class DbgMCU providing a default constructor which enables debugging on STM32 MCUs while using sleep modes.

DevI2C

Helper class DevI2C providing functions for multi-register I2C communication common for a series of I2C devices.

DevSPI

Helper class DevSPI providing functions for SPI communication common for a series of SPI devices.

Diff: DevI2C/DevI2C.h

Revision:
7:55d59a1605c3
Parent:
6:e16d452ac87b
Child:
8:527e203b709b
--- a/DevI2C/DevI2C.h	Fri Jun 05 16:54:47 2015 +0200
+++ b/DevI2C/DevI2C.h	Fri Jun 12 09:29:22 2015 +0200
@@ -59,7 +59,7 @@
 
 	/**
 	 * @brief  Writes a buffer from the I2C peripheral device.
-	 * @param  pBuffer pointer to data to be written.
+	 * @param  pBuffer pointer to the byte-array data to send
 	 * @param  DeviceAddr specifies the peripheral device slave address.
 	 * @param  RegisterAddr specifies the internal address register 
 	 *         where to start writing to (must be correctly masked).
@@ -90,7 +90,7 @@
 
 	/**
 	 * @brief  Reads a buffer from the I2C peripheral device.
-	 * @param  pBuffer pointer to data to be read.
+	 * @param  pBuffer pointer to the byte-array to read data in to
 	 * @param  DaviceAddr specifies the peripheral device slave address.
 	 * @param  RegisterAddr specifies the internal address register 
 	 *         where to start reading from (must be correctly masked).