Diff: SPIHalfDuplex.h

Revision:

8:c14af7958ef5

Parent:

0:8024c367e29f

--- a/SPIHalfDuplex.h	Tue Oct 23 09:20:18 2012 +0000
+++ b/SPIHalfDuplex.h	Fri Nov 09 11:33:53 2012 +0000
@@ -1,11 +1,10 @@
 /* mbed Microcontroller Library - SPIHalfDuplex
  * Copyright (c) 2010-2011 ARM Limited. All rights reserved.
  */
-
 #ifndef MBED_SPIHALFDUPLEX_H
 #define MBED_SPIHALFDUPLEX_H
 
-#include "device.h"
+#include "platform.h"
 
 #if DEVICE_SPI
 
@@ -13,8 +12,7 @@
 
 namespace mbed {
 
-/* Class: SPIHalfDuplex
- *   A SPI half-duplex master, used for communicating with SPI slave devices
+/** A SPI half-duplex master, used for communicating with SPI slave devices
  * over a shared data line.
  *
  * The default format is set to 8-bits for both master and slave, and a
@@ -28,78 +26,49 @@
  * the tri-stating of the MOSI pin.
  *
  * Example:
- * > // Send a byte to a SPI half-duplex slave, and record the response
- * >
- * > #include "mbed.h"
- * > 
- * > SPIHalfDuplex device(p5, p6, p7) // mosi, miso, sclk
- * >
- * > int main() {
- * >     int respone = device.write(0xAA);
- * > }
+ * @code
+ * // Send a byte to a SPI half-duplex slave, and record the response
+ *
+ * #include "mbed.h"
+ * 
+ * SPIHalfDuplex device(p5, p6, p7) // mosi, miso, sclk
+ *
+ * int main() {
+ *     int respone = device.write(0xAA);
+ * }
+ * @endcode
  */
 
 class SPIHalfDuplex : public SPI {
 
 public:
     
-    /* Constructor: SPIHalfDuplex
-     *  Create a SPI half-duplex master connected to the specified pins
-     *
-     * Variables:
-     *  mosi - SPI Master Out, Slave In pin
-     *  miso - SPI Master In, Slave Out pin
-     *  sclk - SPI Clock pin
-     *  name - (optional) A string to identify the object
+    /** Create a SPI half-duplex master connected to the specified pins
      *
      * Pin Options:
      *  (5, 6, 7) or (11, 12, 13)
      *
      *  mosi or miso can be specfied as NC if not used
-     */
-    SPIHalfDuplex(PinName mosi, PinName miso, PinName sclk,
-        const char *name = NULL);
-
-#if 0 // Inherited from SPI - documentation only
-    /* Function: format
-     *  Configure the data transmission format
-     *
-     * Variables:
-     *  bits - Number of bits per SPI frame (4 - 16)
-     *  mode - Clock polarity and phase mode (0 - 3)
      *
-     * > mode | POL PHA
-     * > -----+--------
-     * >   0  |  0   0
-     * >   1  |  0   1
-     * >   2  |  1   0
-     * >   3  |  1   1
+     *  @param mosi SPI Master Out, Slave In pin
+     *  @param miso SPI Master In, Slave Out pin
+     *  @param sclk SPI Clock pin
+     *  @param name (optional) A string to identify the object
      */
-    void format(int bits, int mode = 0);
+    SPIHalfDuplex(PinName mosi, PinName miso, PinName sclk);
 
-    /* Function: frequency
-     *  Set the spi bus clock frequency
+    /** Write to the SPI Slave and return the response
      *
-     * Variables:
-     *  hz - SCLK frequency in hz (default = 1MHz)
-     */
-    void frequency(int hz = 1000000);
-#endif
-
-    /* Function: write
-     *  Write to the SPI Slave and return the response
+     *  @param value Data to be sent to the SPI slave
      *
-     * Variables:
-     *  value - Data to be sent to the SPI slave
-     *  returns - Response from the SPI slave
+     *  @returns
+     *    Response from the SPI slave
      */
     virtual int write(int value);
     
-    /* Function: slave_format
-     *  Set the number of databits expected from the slave, from 4-16
+    /** Set the number of databits expected from the slave, from 4-16
      *
-     * Variables:
-     *  sbits - Number of expected bits in the slave response
+     *  @param sbits Number of expected bits in the slave response
      */
     void slave_format(int sbits);
 
@@ -107,7 +76,6 @@
     PinName _mosi;
     PinName _miso;
     int     _sbits;
-
 }; // End of class
 
 } // End of namespace mbed