The PCAL9555, PCAL9554 series is a low-voltage 16-bit/8-bit General Purpose Input/Output (GPIO) expander with interrupt. This conponent library is compatible to basic operation os GPIO expanders: PCAL9555, PCA9555, PCA9535, PCA9539, PCAL9554, PCA9554 and PCA9538. On addition to this, this library is including mbed-SDK-style APIs. APIs that similar to DigitaiInOut, DigitalOut, DigitalIn, BusInOUt, BusOut and BusIn are available.

Dependents:   PCAL9555_Hello OM13082-JoyStick OM13082_LED OM13082-test ... more

What is this?

This conponent library is compatible to basic operation os GPIO expanders: PCAL9555, PCA9555, PCA9535, PCA9539, PCAL9554, PCA9554 and PCA9538 .

On addition to this, this library is including mbed-SDK-style APIs. APIs that similar to DigitaiInOut, DigitalOut, DigitalIn, BusInOut, BusOut and BusIn are available.

How to use?

Wiring

/media/uploads/nxp_ip/gpio16.png
Wiring between mbed and 16-bit GPIO expander

/media/uploads/nxp_ip/gpio08.png
Wiring between mbed and 8-bit GPIO expander

Very basic register level I/O bit operation

PCAL9555 and PCAL9554 are class libraries for those compatible GPIO expander chips.
Those class libraries provides interface for bit operation of its I/O port.
For 16-bit GPIO expanders, the input/output access and its direction setting can be done by 16-bit data. For 8-bit GPIO expanders, those can be done by 8-bit data.

  #include    "mbed.h"
  #include    "PCAL9555.h"
 
  PCAL9555    gpio( p28, p27, 0xE8 );     //  using PCA9539
 
  int main() {
      gpio.configure( 0xFFFF );           //  Set all pins: input
      printf( "  0x%04X\r\n", (int)gpio );//  Print pins state
 
      gpio.configure( 0x0000 );           //  Set all pins: output
      int count   = 0;
      while(1) {
          gpio.write( count++ );
      }
  }


High level APIs

To use the GPIO expanders more simple, this library is including mbed-SDK-style APIs.
APIs that similar to DigitaiInOut, DigitalOut, DigitalIn, BusInOut, BusOut and BusIn are available.

GpioDigitalOut, GpioDigitaiInOut, GpioDigitalIn

Next code shows sample of DigitalOut equivalent API GpioDigitalOut usage.
A pin on the PCAL9555 is defined as pin and its state is changed by assignment.
(For single pin operation, GpioDigitaiInOut and GpioDigitalIn are available also.)

  #include "mbed.h"
  #include "PCAL9555.h"
  
  PCAL9555        gpio_exp( p28, p27, 0xE8 );    //  SDA, SCL, Slave_address(option)
  GpioDigitalOut  pin( gpio_exp, X0_0 );
   
  int main() {
      while( 1 ) {
          pin = 1;
          wait( 0.2 );
          pin = 0;
          wait( 0.2 );
      }
  }


GpioBusOut, GpioBusInOut, GpioBusIn

BusOut equivalent API GpioBusOut is available too.
In next code, pins are grouped as mypins to manage the output as bus output.
(Same as GpioDigitalInOut and GpioDigitalIn APIs, GpioBusInOut and GpioBusIn are available also.)

  #include "mbed.h"
  #include "PCAL9555.h"
  
  PCAL9555    gpio_exp( p28, p27, 0xE8 );    //  SDA, SCL, Slave_address(option)
  GpioBusOut  mypins( gpio_exp, X0_0, X0_1, X0_2, X0_3 );
   
  int main() {
      while( 1 ) {
          for( int i = 0; i < 16; i++ ) {
              mypins  = i;
              wait( 0.25 );
          }
      }
  }


The high level APIs can be used in combination

Those high level APIs can be used in combination.
Each pins can be managed by instances.

  #include    "mbed.h"
  #include    "PCAL9555.h"
 
  PCAL9555        gpio( p28, p27, 0xE8 );     //  using PCA9539
 
  //  The GPIO pins are grouped in some groups and operated as bus I/O
  GpioBusIn       bus_in( gpio, X0_0, X0_1, X0_2, X0_3 );
  GpioBusOut      bus_out( gpio, X0_4, X0_5, X0_6 );
  GpioBusInOut    bus_io( gpio, X1_7, X1_6, X1_5, X1_4, X1_3, X1_2, X1_1, X1_0 );
  GpioDigitalOut  myled( gpio, X0_7 );
 
  int main() {
      bus_io.input();
      printf( "I/O = 0x%02X\r\n", (int)bus_io );
      printf( "In  = 0x%01X\r\n", (int)bus_in );
 
      bus_io.output();
 
      int count   = 0;
      while(1) {
          bus_out = count;
          bus_io  = count;
          myled   = count & 0x1;
          count++;
          wait( 0.1 );
      }
  }
Committer:
nxp_ip
Date:
Thu Mar 19 02:21:57 2015 +0000
Revision:
1:fd7cfa821b6a
Parent:
0:6c9a51a50eea
API document update

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nxp_ip 0:6c9a51a50eea 1 #include "mbed.h"
nxp_ip 0:6c9a51a50eea 2 #include "PCAL9554.h"
nxp_ip 0:6c9a51a50eea 3
nxp_ip 0:6c9a51a50eea 4
nxp_ip 0:6c9a51a50eea 5 PCAL9554::PCAL9554( PinName i2c_sda, PinName i2c_scl, char i2c_address )
nxp_ip 0:6c9a51a50eea 6 : PCAL955x( i2c_sda, i2c_scl, i2c_address ), n_of_pins( 8 )
nxp_ip 0:6c9a51a50eea 7 {
nxp_ip 0:6c9a51a50eea 8 }
nxp_ip 0:6c9a51a50eea 9
nxp_ip 0:6c9a51a50eea 10 PCAL9554::PCAL9554( I2C &i2c_obj, char i2c_address )
nxp_ip 0:6c9a51a50eea 11 : PCAL955x( i2c_obj, i2c_address ), n_of_pins( 8 )
nxp_ip 0:6c9a51a50eea 12 {
nxp_ip 0:6c9a51a50eea 13 }
nxp_ip 0:6c9a51a50eea 14
nxp_ip 0:6c9a51a50eea 15 PCAL9554::~PCAL9554()
nxp_ip 0:6c9a51a50eea 16 {
nxp_ip 0:6c9a51a50eea 17 }
nxp_ip 0:6c9a51a50eea 18
nxp_ip 0:6c9a51a50eea 19 int PCAL9554::number_of_pins( void )
nxp_ip 0:6c9a51a50eea 20 {
nxp_ip 0:6c9a51a50eea 21 return ( n_of_pins );
nxp_ip 0:6c9a51a50eea 22 }
nxp_ip 0:6c9a51a50eea 23
nxp_ip 0:6c9a51a50eea 24 void PCAL9554::reg_index_write( char reg_index, int data )
nxp_ip 0:6c9a51a50eea 25 {
nxp_ip 0:6c9a51a50eea 26 char a[ 2 ];
nxp_ip 0:6c9a51a50eea 27
nxp_ip 0:6c9a51a50eea 28 a[ 0 ] = regmap[ reg_index ];
nxp_ip 0:6c9a51a50eea 29 a[ 1 ] = data;
nxp_ip 0:6c9a51a50eea 30
nxp_ip 0:6c9a51a50eea 31 bus_write( a, sizeof( a ) );
nxp_ip 0:6c9a51a50eea 32 }
nxp_ip 0:6c9a51a50eea 33
nxp_ip 0:6c9a51a50eea 34 int PCAL9554::reg_index_read( char reg_index )
nxp_ip 0:6c9a51a50eea 35 {
nxp_ip 0:6c9a51a50eea 36 char a;
nxp_ip 0:6c9a51a50eea 37
nxp_ip 0:6c9a51a50eea 38 bus_read( regmap[ reg_index ], &a, sizeof( a ) );
nxp_ip 0:6c9a51a50eea 39
nxp_ip 0:6c9a51a50eea 40 return ( a );
nxp_ip 0:6c9a51a50eea 41 }
nxp_ip 0:6c9a51a50eea 42
nxp_ip 0:6c9a51a50eea 43 PCAL9554& PCAL9554::operator= ( int bit_pattern )
nxp_ip 0:6c9a51a50eea 44 {
nxp_ip 0:6c9a51a50eea 45 write( bit_pattern );
nxp_ip 0:6c9a51a50eea 46 return ( *this );
nxp_ip 0:6c9a51a50eea 47 }
nxp_ip 0:6c9a51a50eea 48
nxp_ip 0:6c9a51a50eea 49 PCAL9554& PCAL9554::operator= ( PCAL9554& rhs )
nxp_ip 0:6c9a51a50eea 50 {
nxp_ip 0:6c9a51a50eea 51 write( rhs.read() );
nxp_ip 0:6c9a51a50eea 52 return *this;
nxp_ip 0:6c9a51a50eea 53 }
nxp_ip 0:6c9a51a50eea 54
nxp_ip 0:6c9a51a50eea 55 const char PCAL9554::regmap[] = {
nxp_ip 0:6c9a51a50eea 56 InputPort,
nxp_ip 0:6c9a51a50eea 57 OutoutPort,
nxp_ip 0:6c9a51a50eea 58 PolarityInversionPort,
nxp_ip 0:6c9a51a50eea 59 ConfigurationPort,
nxp_ip 0:6c9a51a50eea 60 OutputDriveStrength0,
nxp_ip 0:6c9a51a50eea 61 OutputDriveStrength1,
nxp_ip 0:6c9a51a50eea 62 InputLatch,
nxp_ip 0:6c9a51a50eea 63 PullUpPullDowmEnable,
nxp_ip 0:6c9a51a50eea 64 PullUpPullDowmSelection,
nxp_ip 0:6c9a51a50eea 65 InterruptMask,
nxp_ip 0:6c9a51a50eea 66 InterruptStatus,
nxp_ip 0:6c9a51a50eea 67 OutputPortConfiguration
nxp_ip 0:6c9a51a50eea 68 };