GpioDigitalOut.h

00001 /** GpioDigitalInOut API for GPIO-expander component class 
00002  *
00003  *  @author  Akifumi (Tedd) OKANO, NXP Semiconductors
00004  *  @version 0.6
00005  *  @date    19-Mar-2015
00006  *
00007  *  Released under the Apache 2 license
00008  */
00009 
00010 #ifndef     MBED_GpioDigitalOut
00011 #define     MBED_GpioDigitalOut
00012 
00013 #include    "mbed.h"
00014 #include    "GpioDigitalInOut.h"
00015 
00016 /** GpioDigitalOut class
00017  *
00018  *  @class GpioDigitalOut
00019  *
00020  *  "GpioDigitalOut" class works like "DigitalOut" class of mbed-SDK. 
00021  *  This class provides pin oriented API, abstracting the GPIO-expander chip. 
00022  *
00023  *  Example:
00024  *  @code
00025  *  #include "mbed.h"
00026  *  #include "PCAL9555.h"
00027  *  
00028  *  PCAL9555        gpio_exp( p28, p27, 0xE8 );    //  SDA, SCL, Slave_address(option)
00029  *  GpioDigitalOut  pin( gpio_exp, X0_0 );
00030  *   
00031  *  int main() {
00032  *      while( 1 ) {
00033  *          pin = 1;
00034  *          wait( 0.2 );
00035  *          pin = 0;
00036  *          wait( 0.2 );
00037  *      }
00038  *  }
00039  *  @endcode
00040  */
00041  class GpioDigitalOut : public GpioDigitalInOut
00042 {
00043 public:
00044 
00045 #if DOXYGEN_ONLY
00046     /** GPIO-Expander pin names */
00047     typedef enum {
00048     X0_0,           /**< P0_0 pin                                   */
00049     X0_1,           /**< P0_1 pin                                   */
00050     X0_2,           /**< P0_2 pin                                   */
00051     X0_3,           /**< P0_3 pin                                   */
00052     X0_4,           /**< P0_4 pin                                   */
00053     X0_5,           /**< P0_5 pin                                   */
00054     X0_6,           /**< P0_6 pin                                   */
00055     X0_7,           /**< P0_7 pin                                   */
00056     X1_0,           /**< P1_0 pin (for 16-bit GPIO device only)     */
00057     X1_1,           /**< P1_1 pin (for 16-bit GPIO device only)     */
00058     X1_2,           /**< P1_2 pin (for 16-bit GPIO device only)     */
00059     X1_3,           /**< P1_3 pin (for 16-bit GPIO device only)     */
00060     X1_4,           /**< P1_4 pin (for 16-bit GPIO device only)     */
00061     X1_5,           /**< P1_5 pin (for 16-bit GPIO device only)     */
00062     X1_6,           /**< P1_6 pin (for 16-bit GPIO device only)     */
00063     X1_7,           /**< P1_7 pin (for 16-bit GPIO device only)     */
00064     X0  = X0_0,     /**< P0_0 pin                                   */
00065     X1  = X0_1,     /**< P0_1 pin                                   */
00066     X2  = X0_2,     /**< P0_2 pin                                   */
00067     X3  = X0_3,     /**< P0_3 pin                                   */
00068     X4  = X0_4,     /**< P0_4 pin                                   */
00069     X5  = X0_5,     /**< P0_5 pin                                   */
00070     X6  = X0_6,     /**< P0_6 pin                                   */
00071     X7  = X0_7,     /**< P0_7 pin                                   */
00072     X8  = X1_0,     /**< P1_0 pin (for 16-bit GPIO device only)     */
00073     X9  = X1_1,     /**< P1_1 pin (for 16-bit GPIO device only)     */
00074     X10 = X1_2,     /**< P1_2 pin (for 16-bit GPIO device only)     */
00075     X11 = X1_3,     /**< P1_3 pin (for 16-bit GPIO device only)     */
00076     X12 = X1_4,     /**< P1_4 pin (for 16-bit GPIO device only)     */
00077     X13 = X1_5,     /**< P1_5 pin (for 16-bit GPIO device only)     */
00078     X14 = X1_6,     /**< P1_6 pin (for 16-bit GPIO device only)     */
00079     X15 = X1_7,     /**< P1_7 pin (for 16-bit GPIO device only)     */
00080     
00081     X_NC = ~0x0L    /**< for when the pin is left no-connection     */
00082     } GpioPinName;
00083 #endif
00084 
00085     /** Create a GpioDigitalOut connected to the specified pin
00086      *
00087      *  @param gpiop    Instance of GPIO expander device
00088      *  @param pin_name DigitalInOut pin to connect to
00089      */
00090     GpioDigitalOut( CompGpioExp &gpiop, GpioPinName pin_name );
00091 
00092     /**
00093      *  Destractor
00094      */
00095     virtual ~GpioDigitalOut();
00096 
00097     /** A shorthand for write()
00098      */
00099     GpioDigitalOut&     operator= ( int rhs );
00100     GpioDigitalOut&     operator= ( GpioDigitalOut& rhs );
00101 }
00102 ;
00103 
00104 #endif  //  MBED_GpioDigitalOut