Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: PCAL9555_Hello OM13082-JoyStick OM13082_LED OM13082-test ... more
Revision 1:fd7cfa821b6a, committed 2015-03-19
- Comitter:
- nxp_ip
- Date:
- Thu Mar 19 02:21:57 2015 +0000
- Parent:
- 0:6c9a51a50eea
- Commit message:
- API document update
Changed in this revision
--- a/PCAL9554/PCAL9554.h Sat Mar 07 12:56:05 2015 +0000 +++ b/PCAL9554/PCAL9554.h Thu Mar 19 02:21:57 2015 +0000 @@ -5,8 +5,8 @@ * * @class PCAL9554 * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license * @@ -31,9 +31,12 @@ * * PCAL9554 library's basic IO operation is compatible to PCA9554, PCA9538. * This library can be used for those GPIO expander chips also. + * Next sample code shows operation based on low-level-API (operated by just device instane) * * Example: * @code + * // GPIO-expander operation sample using a device instance + * * #include "mbed.h" * #include "PCAL9555.h" * @@ -57,6 +60,8 @@ * The GpioDigital* and GpioBus* APIs can be used as next sample code. * * @code + * // GPIO-expander operation sample using high-level-API + * * #include "mbed.h" * #include "PCAL9554.h" * @@ -81,45 +86,52 @@ */ class PCAL9554 : public PCAL955x { -#if DOXYGEN_ONLY - //* GPIO-Expander pin names */ - typedef enum { - X0_0, /**< P0_0 pin */ - X0_1, /**< P0_1 pin */ - X0_2, /**< P0_2 pin */ - X0_3, /**< P0_3 pin */ - X0_4, /**< P0_4 pin */ - X0_5, /**< P0_5 pin */ - X0_6, /**< P0_6 pin */ - X0_7, /**< P0_7 pin */ - X0 = X0_0, /**< P0_0 pin */ - X1 = X0_1, /**< P0_1 pin */ - X2 = X0_2, /**< P0_2 pin */ - X3 = X0_3, /**< P0_3 pin */ - X4 = X0_4, /**< P0_4 pin */ - X5 = X0_5, /**< P0_5 pin */ - X6 = X0_6, /**< P0_6 pin */ - X7 = X0_7, /**< P0_7 pin */ - X_NC = ~0x0L /**< for when the pin is left no-connection */ - } GpioPinName; -#endif + public: /** Name of the PCAL9554 registers */ enum command_reg { - InputPort = 0x00, - OutoutPort, - PolarityInversionPort, - ConfigurationPort, - OutputDriveStrength0 = 0x40, - OutputDriveStrength1, - InputLatch, - PullUpPullDowmEnable, - PullUpPullDowmSelection, - InterruptMask, - InterruptStatus, - OutputPortConfiguration = 0x4F, + InputPort = 0x00, /**< InputPort register */ + OutoutPort, /**< OutoutPort register */ + PolarityInversionPort, /**< PolarityInversionPort register */ + ConfigurationPort, /**< ConfigurationPort register */ + OutputDriveStrength0 = 0x40, /**< OutputDriveStrength0 register */ + OutputDriveStrength1, /**< OutputDriveStrength1 register */ + InputLatch, /**< InputLatch register */ + PullUpPullDowmEnable, /**< PullUpPullDowmEnable register */ + PullUpPullDowmSelection, /**< PullUpPullDowmSelection register */ + InterruptMask, /**< InterruptMask register */ + InterruptStatus, /**< InterruptStatus register */ + OutputPortConfiguration = 0x4F, /**< OutputPortConfiguration register */ }; +#if DOXYGEN_ONLY + /** GPIO-Expander pin names + * for when the high-level APIs + * (GpioDigitalOut, GpioDigitalInOut, GpioDigitalIn, + * GpioBusOut, GpioBusInOut are GpioBusIn) are used + */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create a PCAL9554 instance connected to specified I2C pins with specified address * * @param i2c_sda I2C-bus SDA pin
--- a/PCAL9555/PCAL9555.h Sat Mar 07 12:56:05 2015 +0000 +++ b/PCAL9555/PCAL9555.h Thu Mar 19 02:21:57 2015 +0000 @@ -5,8 +5,8 @@ * * @class PCAL9555 * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license * @@ -30,9 +30,12 @@ * * PCAL9555 library's basic IO operation is compatible to PCA9555, PCA9535 and PCA9539. * This library can be used for those GPIO expander chips also. + * Next sample code shows operation based on low-level-API (operated by just device instane) * * Example: * @code + * // GPIO-expander operation sample using a device instance + * * #include "mbed.h" * #include "PCAL9555.h" * @@ -52,10 +55,12 @@ * * GpioDigitalInOut, GpioDigitalOut, GpioDigitalIn, * GpioBusInOut, GpioBusOut and GpioBusIn API class are available also. - * For those API details, please find those class library page. - * The GpioDigital* and GpioBus* APIs can be used as next sample code. + * For those high-level-API details, please find those class library page. + * The GpioDigital* and GpioBus* APIs can be used like next sample code. * * @code + * // GPIO-expander operation sample using high-level-API + * * #include "mbed.h" * #include "PCAL9555.h" * @@ -88,73 +93,78 @@ class PCAL9555 : public PCAL955x { -#if DOXYGEN_ONLY - //* GPIO-Expander pin names */ - typedef enum { - X0_0, /**< P0_0 pin */ - X0_1, /**< P0_1 pin */ - X0_2, /**< P0_2 pin */ - X0_3, /**< P0_3 pin */ - X0_4, /**< P0_4 pin */ - X0_5, /**< P0_5 pin */ - X0_6, /**< P0_6 pin */ - X0_7, /**< P0_7 pin */ - X1_0, /**< P1_0 pin */ - X1_1, /**< P1_1 pin */ - X1_2, /**< P1_2 pin */ - X1_3, /**< P1_3 pin */ - X1_4, /**< P1_4 pin */ - X1_5, /**< P1_5 pin */ - X1_6, /**< P1_6 pin */ - X1_7, /**< P1_7 pin */ - X0 = X0_0, /**< P0_0 pin */ - X1 = X0_1, /**< P0_1 pin */ - X2 = X0_2, /**< P0_2 pin */ - X3 = X0_3, /**< P0_3 pin */ - X4 = X0_4, /**< P0_4 pin */ - X5 = X0_5, /**< P0_5 pin */ - X6 = X0_6, /**< P0_6 pin */ - X7 = X0_7, /**< P0_7 pin */ - X8 = X1_0, /**< P1_0 pin */ - X9 = X1_1, /**< P1_1 pin */ - X10 = X1_2, /**< P1_2 pin */ - X11 = X1_3, /**< P1_3 pin */ - X12 = X1_4, /**< P1_4 pin */ - X13 = X1_5, /**< P1_5 pin */ - X14 = X1_6, /**< P1_6 pin */ - X15 = X1_7, /**< P1_7 pin */ - - X_NC = ~0x0L /**< for when the pin is left no-connection */ - } GpioPinName; -#endif public: /** Name of the PCAL9555 registers */ enum command_reg { - InputPort0 = 0x00, - InputPort1, - OutoutPort0, - OutoutPort1, - PolarityInversionPort0, - PolarityInversionPort1, - ConfigurationPort0, - ConfigurationPort1, - OutputDriveStrength0_0 = 0x40, - OutputDriveStrength0_1, - OutputDriveStrength1_0, - OutputDriveStrength1_1, - InputLatch0, - InputLatch1, - PullUpPullDowmEnable0, - PullUpPullDowmEnable1, - PullUpPullDowmSelection0, - PullUpPullDowmSelection1, - InterruptMask0, - InterruptMask1, - InterruptStatus0, - InterruptStatus1, - OutputPortConfiguration = 0x4F, + InputPort0 = 0x00, /**< InputPort0 register */ + InputPort1, /**< InputPort1 register */ + OutoutPort0, /**< OutoutPort0 register */ + OutoutPort1, /**< OutoutPort1 register */ + PolarityInversionPort0, /**< PolarityInversionPort0 register */ + PolarityInversionPort1, /**< PolarityInversionPort1 register */ + ConfigurationPort0, /**< ConfigurationPort0 register */ + ConfigurationPort1, /**< ConfigurationPort1 register */ + OutputDriveStrength0_0 = 0x40, /**< OutputDriveStrength0_0 register */ + OutputDriveStrength0_1, /**< OutputDriveStrength0_1 register */ + OutputDriveStrength1_0, /**< OutputDriveStrength1_0 register */ + OutputDriveStrength1_1, /**< OutputDriveStrength1_1 register */ + InputLatch0, /**< InputLatch0 register */ + InputLatch1, /**< InputLatch1 register */ + PullUpPullDowmEnable0, /**< PullUpPullDowmEnable0 register */ + PullUpPullDowmEnable1, /**< PullUpPullDowmEnable1 register */ + PullUpPullDowmSelection0, /**< PullUpPullDowmSelection0 register */ + PullUpPullDowmSelection1, /**< PullUpPullDowmSelection1 register */ + InterruptMask0, /**< InterruptMask0 register */ + InterruptMask1, /**< InterruptMask1 register */ + InterruptStatus0, /**< InterruptStatus0 register */ + InterruptStatus1, /**< InterruptStatus1 register */ + OutputPortConfiguration = 0x4F, /**< OutputPortConfiguration register */ }; +#if DOXYGEN_ONLY + /** GPIO-Expander pin names + * for when the high-level APIs + * (GpioDigitalOut, GpioDigitalInOut, GpioDigitalIn, + * GpioBusOut, GpioBusInOut are GpioBusIn) are used + */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X1_0, /**< P1_0 pin */ + X1_1, /**< P1_1 pin */ + X1_2, /**< P1_2 pin */ + X1_3, /**< P1_3 pin */ + X1_4, /**< P1_4 pin */ + X1_5, /**< P1_5 pin */ + X1_6, /**< P1_6 pin */ + X1_7, /**< P1_7 pin */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + X8 = X1_0, /**< P1_0 pin */ + X9 = X1_1, /**< P1_1 pin */ + X10 = X1_2, /**< P1_2 pin */ + X11 = X1_3, /**< P1_3 pin */ + X12 = X1_4, /**< P1_4 pin */ + X13 = X1_5, /**< P1_5 pin */ + X14 = X1_6, /**< P1_6 pin */ + X15 = X1_7, /**< P1_7 pin */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create a PCAL9555 instance connected to specified I2C pins with specified address * * @param i2c_sda I2C-bus SDA pin
--- a/base_classes/CompGpioExp/CompGpioExp.h Sat Mar 07 12:56:05 2015 +0000 +++ b/base_classes/CompGpioExp/CompGpioExp.h Thu Mar 19 02:21:57 2015 +0000 @@ -4,8 +4,8 @@ * * @class CompGpioExp * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license */ @@ -25,14 +25,14 @@ X0_5, /**< P0_5 pin */ X0_6, /**< P0_6 pin */ X0_7, /**< P0_7 pin */ - X1_0, /**< P1_0 pin */ - X1_1, /**< P1_1 pin */ - X1_2, /**< P1_2 pin */ - X1_3, /**< P1_3 pin */ - X1_4, /**< P1_4 pin */ - X1_5, /**< P1_5 pin */ - X1_6, /**< P1_6 pin */ - X1_7, /**< P1_7 pin */ + X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ X0 = X0_0, /**< P0_0 pin */ X1 = X0_1, /**< P0_1 pin */ X2 = X0_2, /**< P0_2 pin */ @@ -41,14 +41,14 @@ X5 = X0_5, /**< P0_5 pin */ X6 = X0_6, /**< P0_6 pin */ X7 = X0_7, /**< P0_7 pin */ - X8 = X1_0, /**< P1_0 pin */ - X9 = X1_1, /**< P1_1 pin */ - X10 = X1_2, /**< P1_2 pin */ - X11 = X1_3, /**< P1_3 pin */ - X12 = X1_4, /**< P1_4 pin */ - X13 = X1_5, /**< P1_5 pin */ - X14 = X1_6, /**< P1_6 pin */ - X15 = X1_7, /**< P1_7 pin */ + X8 = X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X9 = X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X10 = X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X11 = X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X12 = X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X13 = X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X14 = X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X15 = X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ X_NC = ~0x0L /**< for when the pin is left no-connection */ } GpioPinName;
--- a/base_classes/CompGpioExp/GpioBus/GpioBusIn.h Sat Mar 07 12:56:05 2015 +0000 +++ b/base_classes/CompGpioExp/GpioBus/GpioBusIn.h Thu Mar 19 02:21:57 2015 +0000 @@ -1,8 +1,8 @@ /** GpioBusIn API for GPIO-expander component class * * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license */ @@ -13,11 +13,11 @@ #include "mbed.h" #include "GpioBusInOut.h" -/** GpioDigitalIn class +/** GpioBusIn class * - * @class GpioDigitalIn + * @class GpioBusIn * - * "GpioDigitalIn" class works like "DigitalIn" class of mbed-SDK. + * "GpioBusIn" class works like "BusIn" class of mbed-SDK. * This class provides pin oriented API, abstracting the GPIO-expander chip. * * Example: @@ -42,6 +42,46 @@ { public: +#if DOXYGEN_ONLY + /** GPIO-Expander pin names */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + X8 = X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X9 = X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X10 = X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X11 = X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X12 = X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X13 = X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X14 = X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X15 = X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create an GpioBusIn, connected to the specified pins * * @param gpiop Instance of GPIO expander device
--- a/base_classes/CompGpioExp/GpioBus/GpioBusInOut.h Sat Mar 07 12:56:05 2015 +0000 +++ b/base_classes/CompGpioExp/GpioBus/GpioBusInOut.h Thu Mar 19 02:21:57 2015 +0000 @@ -1,8 +1,8 @@ /** GpioBusInOut API for GPIO-expander component class * * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license */ @@ -45,6 +45,46 @@ { public: +#if DOXYGEN_ONLY + /** GPIO-Expander pin names */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + X8 = X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X9 = X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X10 = X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X11 = X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X12 = X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X13 = X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X14 = X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X15 = X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create an GpioBusInOut, connected to the specified pins * * @param gpiop Instance of GPIO expander device
--- a/base_classes/CompGpioExp/GpioBus/GpioBusOut.h Sat Mar 07 12:56:05 2015 +0000 +++ b/base_classes/CompGpioExp/GpioBus/GpioBusOut.h Thu Mar 19 02:21:57 2015 +0000 @@ -1,8 +1,8 @@ /** GpioBusOut API for GPIO-expander component class * * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license */ @@ -42,6 +42,46 @@ { public: +#if DOXYGEN_ONLY + /** GPIO-Expander pin names */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + X8 = X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X9 = X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X10 = X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X11 = X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X12 = X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X13 = X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X14 = X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X15 = X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create an GpioBusOut, connected to the specified pins * * @param gpiop Instance of GPIO expander device
--- a/base_classes/CompGpioExp/GpioDigital/GpioDigitalIn.h Sat Mar 07 12:56:05 2015 +0000 +++ b/base_classes/CompGpioExp/GpioDigital/GpioDigitalIn.h Thu Mar 19 02:21:57 2015 +0000 @@ -1,8 +1,8 @@ /** GpioDigitalIn API for GPIO-expander component class * * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license */ @@ -44,6 +44,47 @@ class GpioDigitalIn : public GpioDigitalInOut { public: + +#if DOXYGEN_ONLY + /** GPIO-Expander pin names */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + X8 = X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X9 = X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X10 = X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X11 = X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X12 = X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X13 = X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X14 = X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X15 = X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create a GpioDigitalInOut connected to the specified pin * * @param gpiop Instance of GPIO expander device
--- a/base_classes/CompGpioExp/GpioDigital/GpioDigitalInOut.h Sat Mar 07 12:56:05 2015 +0000 +++ b/base_classes/CompGpioExp/GpioDigital/GpioDigitalInOut.h Thu Mar 19 02:21:57 2015 +0000 @@ -1,8 +1,8 @@ /** GpioDigitalInOut API for GPIO-expander component class * * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license */ @@ -43,6 +43,46 @@ { public: +#if DOXYGEN_ONLY + /** GPIO-Expander pin names */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + X8 = X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X9 = X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X10 = X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X11 = X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X12 = X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X13 = X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X14 = X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X15 = X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create a GpioDigitalInOut connected to the specified pin * * @param gpiop Instance of GPIO expander device
--- a/base_classes/CompGpioExp/GpioDigital/GpioDigitalOut.h Sat Mar 07 12:56:05 2015 +0000 +++ b/base_classes/CompGpioExp/GpioDigital/GpioDigitalOut.h Thu Mar 19 02:21:57 2015 +0000 @@ -1,8 +1,8 @@ /** GpioDigitalInOut API for GPIO-expander component class * * @author Akifumi (Tedd) OKANO, NXP Semiconductors - * @version 0.5 - * @date 07-Mar-2015 + * @version 0.6 + * @date 19-Mar-2015 * * Released under the Apache 2 license */ @@ -41,6 +41,47 @@ class GpioDigitalOut : public GpioDigitalInOut { public: + +#if DOXYGEN_ONLY + /** GPIO-Expander pin names */ + typedef enum { + X0_0, /**< P0_0 pin */ + X0_1, /**< P0_1 pin */ + X0_2, /**< P0_2 pin */ + X0_3, /**< P0_3 pin */ + X0_4, /**< P0_4 pin */ + X0_5, /**< P0_5 pin */ + X0_6, /**< P0_6 pin */ + X0_7, /**< P0_7 pin */ + X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + X0 = X0_0, /**< P0_0 pin */ + X1 = X0_1, /**< P0_1 pin */ + X2 = X0_2, /**< P0_2 pin */ + X3 = X0_3, /**< P0_3 pin */ + X4 = X0_4, /**< P0_4 pin */ + X5 = X0_5, /**< P0_5 pin */ + X6 = X0_6, /**< P0_6 pin */ + X7 = X0_7, /**< P0_7 pin */ + X8 = X1_0, /**< P1_0 pin (for 16-bit GPIO device only) */ + X9 = X1_1, /**< P1_1 pin (for 16-bit GPIO device only) */ + X10 = X1_2, /**< P1_2 pin (for 16-bit GPIO device only) */ + X11 = X1_3, /**< P1_3 pin (for 16-bit GPIO device only) */ + X12 = X1_4, /**< P1_4 pin (for 16-bit GPIO device only) */ + X13 = X1_5, /**< P1_5 pin (for 16-bit GPIO device only) */ + X14 = X1_6, /**< P1_6 pin (for 16-bit GPIO device only) */ + X15 = X1_7, /**< P1_7 pin (for 16-bit GPIO device only) */ + + X_NC = ~0x0L /**< for when the pin is left no-connection */ + } GpioPinName; +#endif + /** Create a GpioDigitalOut connected to the specified pin * * @param gpiop Instance of GPIO expander device