PCA9955A and PCA9956A class library. The PCA9955A is a 16-channel and the PCA9956A is a 24-channel Fm+ I2C-bus 57mA/20V constant current LED driver. The PCA9955A has a extended feature which called "Gradation control".

Dependencies:   CompLedDvrCC

Dependents:   PCA9956A_Hello pca9956b_two_demoboards PCA9955A_Gradation_control PCA9955A_Gradation_control ... more

What is this?

Code for PCA9956A and PCA9955A.
24-channel and 16-channel constant current type LED driver component class.

Please refer to the component page for details

PCA9955B and PCA9956B are I²C-bus controlled 16-channel constant current LED driver optimized for dimming and blinking.

High-level API is available

A high-level API that can be used as the "PwmOut" of bed-SDK is available.
This API enables to make instances of each LED output pins and control PWM duty cycle by assignment.
Output current also controllable by API function.
For detail information, refer API document of LedPwmOutCC Class class which is included in PCA995xA class library.

#include "mbed.h"
#include "PCA9956A.h"

PCA9956A    led_cntlr( p28, p27, 0xC4 );  //  SDA, SCL, Slave_address(option)
LedPwmOutCC led( led_cntlr, L0 );

int main()
{
    while( 1 ) {
        for( float p = 0.0f; p < 1.0f; p += 0.1f ) {
            led     = p;
            wait( 0.1 );
        }
    }
}

About the chips

PCA9956A

The PCA9956A is an I2C-bus controlled 24-channel constant current LED driver optimized for dimming and blinking 57 mA LEDs. Each LED output has its own 8-bit resolution (256 steps) fixed frequency individual PWM controller that operates at 31.25 kHz with a duty cycle that is adjustable from 0 % to 99.6 % to allow the LED to be set to a specific brightness value.

Datasheet: http://www.nxp.com/documents/data_sheet/PCA9956A.pdf

PCA9955A

The PCA9955A is an I2C-bus controlled 16-channel constant current LED driver optimized for dimming and blinking 57 mA Red/Green/Blue/Amber (RGBA) LEDs in amusement products. Each LED output has its own 8-bit resolution (256 steps) fixed frequency individual PWM controller that operates at 31.25 kHz with a duty cycle that is adjustable from 0 % to 100 % to allow the LED to be set to a specific brightness value.

On addition to this, the PCA9955A has "Gradation control".
The gradation control is a new feature of PCA995xA series. After the register setting and start the control, the PCA9955A performs dimming cycles automatically without MCU intervention.

Datasheet: http://www.nxp.com/documents/data_sheet/PCA9955A.pdf

PCA9952 and PCA9955 (non-A version)

The PCA9955 and PCA9955 (no-A at end of the type number) is not supported by this component class.

PCA9955(non-A)

PCA9955A != PCA9955

PCA9955A is not software compatible to PCA9955(non-A version).
There are several differences between A and non-A versions.
Register mapping is one of the difference. Please make sure you are using PCA9955A.

How the API works?

When the instance is made, all set up for PWM operation are done automatically.
For the operation, user can control the LED brightness in two ways.

  • PWM
  • Current

PCA9955A and PCA9956A have internal 31.25kHz oscillator to generate internal PWM waveform. This signal switchs the output current ON and OFF. The class' function pwm() controls duty-cycle of this output.

Another control is current. Since the PCA9955A and PCA9956A are constant current type LED driver, those have internal current sources. The current source on each channels has independent control of output current. The class' function current() provides interface to current change.

API_and_output

Tips for the chips

PCA995xA family

This PCA995xA components library can be used for both PCA9955A(16-channel) and PCA9956A(24-channel).
If you are using both chips on the I2C bus, those can be operated like..

#include "mbed.h"
 
#include "PCA9955A.h"
#include "PCA9956A.h"

PCA9955A    led0( p28, p27, 0xC0 );    //  SDA, SCL, Slave_address=0xC0 (16-channel chip)
PCA9956A    led1( p28, p27, 0xC2 );    //  SDA, SCL, Slave_address=0xC2 (24-channel chip)
 
int main()
{
    led0.current( ALLPORTS, 1.0 ); //  Set all ports output current 100%
    led1.current( ALLPORTS, 1.0 ); //  Set all ports output current 100%

    led0.pwm( ....    //  PWM control for PCA9955A(16-channel chip)
    led1.pwm( ....    //  PWM control for PCA9956A(24-channel chip)
    ...

Other sample code

For PCA9955A : http://developer.mbed.org/users/nxp_ip/code/PCA9955A_Hello/
For PCA9956A : http://developer.mbed.org/users/nxp_ip/code/PCA9956A_Hello/
For Gradation control of PCA9955A http://developer.mbed.org/users/nxp_ip/code/PCA9955A_Gradation_control/

Committer:
nxp_ip
Date:
Wed Feb 25 06:42:41 2015 +0000
Revision:
0:a624e2eeccac
Child:
1:3522be54a4f5
Initial version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
nxp_ip 0:a624e2eeccac 1 /** PCA9955A constant current LED driver
nxp_ip 0:a624e2eeccac 2 *
nxp_ip 0:a624e2eeccac 3 * An operation sample of PCA9955A 16-channel Fm+ I2C-bus 57mA/20V constant current LED driver.
nxp_ip 0:a624e2eeccac 4 * mbed accesses PCA9955A registers via I2C.
nxp_ip 0:a624e2eeccac 5 *
nxp_ip 0:a624e2eeccac 6 * @class PCA9955A
nxp_ip 0:a624e2eeccac 7 * @author Akifumi (Tedd) OKANO, NXP Semiconductors
nxp_ip 0:a624e2eeccac 8 * @version 0.5
nxp_ip 0:a624e2eeccac 9 * @date 25-Feb-2015
nxp_ip 0:a624e2eeccac 10 *
nxp_ip 0:a624e2eeccac 11 * Released under the Apache 2 license License
nxp_ip 0:a624e2eeccac 12 *
nxp_ip 0:a624e2eeccac 13 * About PCA9955A:
nxp_ip 0:a624e2eeccac 14 * http://www.nxp.com/products/interface_and_connectivity/i2c/i2c_led_display_control/PCA9955ATW.html
nxp_ip 0:a624e2eeccac 15 */
nxp_ip 0:a624e2eeccac 16
nxp_ip 0:a624e2eeccac 17 #ifndef MBED_PCA9955A
nxp_ip 0:a624e2eeccac 18 #define MBED_PCA9955A
nxp_ip 0:a624e2eeccac 19
nxp_ip 0:a624e2eeccac 20 #include "mbed.h"
nxp_ip 0:a624e2eeccac 21 #include "PCA995xA.h"
nxp_ip 0:a624e2eeccac 22
nxp_ip 0:a624e2eeccac 23 /** PCA9955A class
nxp_ip 0:a624e2eeccac 24 *
nxp_ip 0:a624e2eeccac 25 * This is a driver code for the PCA9955A 16-channel Fm+ I2C-bus 57mA/20V constant current LED driver.
nxp_ip 0:a624e2eeccac 26 * This class provides interface for PCA9955A operation and accessing its registers.
nxp_ip 0:a624e2eeccac 27 * Detail information is available on next URL.
nxp_ip 0:a624e2eeccac 28 * http://www.nxp.com/products/interface_and_connectivity/i2c/i2c_led_display_control/PCA9955ATW.html
nxp_ip 0:a624e2eeccac 29 *
nxp_ip 0:a624e2eeccac 30 * Example:
nxp_ip 0:a624e2eeccac 31 * @code
nxp_ip 0:a624e2eeccac 32 * #include "mbed.h"
nxp_ip 0:a624e2eeccac 33 *
nxp_ip 0:a624e2eeccac 34 * #include "PCA9955A.h"
nxp_ip 0:a624e2eeccac 35 * PCA9955A led_cntlr( p28, p27, 0x02 ); // SDA, SCL, Slave_address(option)
nxp_ip 0:a624e2eeccac 36 *
nxp_ip 0:a624e2eeccac 37 * int main()
nxp_ip 0:a624e2eeccac 38 * {
nxp_ip 0:a624e2eeccac 39 * led_cntlr.current( ALLPORTS, 1.0 ); // Set all ports output current 100%
nxp_ip 0:a624e2eeccac 40 *
nxp_ip 0:a624e2eeccac 41 * while(1) {
nxp_ip 0:a624e2eeccac 42 * for ( int port = 0; port < led_cntlr.number_of_ports(); port++ ) {
nxp_ip 0:a624e2eeccac 43 * for ( int i = 1; i <= 100; i++ ) {
nxp_ip 0:a624e2eeccac 44 * led_cntlr.pwm( port, (float)i / 100.0 );
nxp_ip 0:a624e2eeccac 45 * wait( 0.01 );
nxp_ip 0:a624e2eeccac 46 * }
nxp_ip 0:a624e2eeccac 47 * }
nxp_ip 0:a624e2eeccac 48 * led_cntlr.pwm( ALLPORTS, 0.0 );
nxp_ip 0:a624e2eeccac 49 * }
nxp_ip 0:a624e2eeccac 50 * }
nxp_ip 0:a624e2eeccac 51 * @endcode
nxp_ip 0:a624e2eeccac 52 */
nxp_ip 0:a624e2eeccac 53 class PCA9955A : public PCA995xA
nxp_ip 0:a624e2eeccac 54 {
nxp_ip 0:a624e2eeccac 55 public:
nxp_ip 0:a624e2eeccac 56 /** Name of the PCA9955A registers */
nxp_ip 0:a624e2eeccac 57 enum command_reg {
nxp_ip 0:a624e2eeccac 58 MODE1 = 0x00,
nxp_ip 0:a624e2eeccac 59 MODE2,
nxp_ip 0:a624e2eeccac 60 LEDOUT0, LEDOUT1, LEDOUT2, LEDOUT3,
nxp_ip 0:a624e2eeccac 61 GRPPWM = 0x06,
nxp_ip 0:a624e2eeccac 62 GRPFREQ,
nxp_ip 0:a624e2eeccac 63 PWM0, PWM1, PWM2, PWM3,
nxp_ip 0:a624e2eeccac 64 PWM4, PWM5, PWM6, PWM7,
nxp_ip 0:a624e2eeccac 65 PWM8, PWM9, PWM10, PWM11,
nxp_ip 0:a624e2eeccac 66 PWM12, PWM13, PWM14, PWM15,
nxp_ip 0:a624e2eeccac 67 IREF0, IREF1, IREF2, IREF3,
nxp_ip 0:a624e2eeccac 68 IREF4, IREF5, IREF6, IREF7,
nxp_ip 0:a624e2eeccac 69 IREF8, IREF9, IREF10, IREF11,
nxp_ip 0:a624e2eeccac 70 IREF12, IREF13, IREF14, IREF15,
nxp_ip 0:a624e2eeccac 71 RAMP_RATE_GRP0, STEP_TIME_GRP0, HOLD_CNTL_GRP0, IREF_GRP0,
nxp_ip 0:a624e2eeccac 72 RAMP_RATE_GRP1, STEP_TIME_GRP1, HOLD_CNTL_GRP1, IREF_GRP1,
nxp_ip 0:a624e2eeccac 73 RAMP_RATE_GRP2, STEP_TIME_GRP2, HOLD_CNTL_GRP2, IREF_GRP2,
nxp_ip 0:a624e2eeccac 74 RAMP_RATE_GRP3, STEP_TIME_GRP3, HOLD_CNTL_GRP3, IREF_GRP3,
nxp_ip 0:a624e2eeccac 75 GRAD_MODE_SEL0 = 0x38,
nxp_ip 0:a624e2eeccac 76 GRAD_MODE_SEL1,
nxp_ip 0:a624e2eeccac 77 GRAD_GRP_SEL0, GRAD_GRP_SEL1, GRAD_GRP_SEL2, GRAD_GRP_SEL3,
nxp_ip 0:a624e2eeccac 78 GRAD_CNTL,
nxp_ip 0:a624e2eeccac 79 OFFSET = 0x3F,
nxp_ip 0:a624e2eeccac 80 SUBADR1, SUBADR2, SUBADR3, ALLCALLADR,
nxp_ip 0:a624e2eeccac 81 PWMALL, IREFALL,
nxp_ip 0:a624e2eeccac 82 EFLAG0, EFLAG1,
nxp_ip 0:a624e2eeccac 83
nxp_ip 0:a624e2eeccac 84 REGISTER_START = MODE1,
nxp_ip 0:a624e2eeccac 85 LEDOUT_REGISTER_START = LEDOUT0,
nxp_ip 0:a624e2eeccac 86 PWM_REGISTER_START = PWM0,
nxp_ip 0:a624e2eeccac 87 IREF_REGISTER_START = IREF0,
nxp_ip 0:a624e2eeccac 88 GRAD_GROUP_OFFSET = RAMP_RATE_GRP1 - RAMP_RATE_GRP0
nxp_ip 0:a624e2eeccac 89 };
nxp_ip 0:a624e2eeccac 90
nxp_ip 0:a624e2eeccac 91 /** Create a PCA9629A instance connected to specified I2C pins with specified address
nxp_ip 0:a624e2eeccac 92 *
nxp_ip 0:a624e2eeccac 93 * @param i2c_sda I2C-bus SDA pin
nxp_ip 0:a624e2eeccac 94 * @param i2c_sda I2C-bus SCL pin
nxp_ip 0:a624e2eeccac 95 * @param i2c_address (option) I2C-bus address (default: 0xC0)
nxp_ip 0:a624e2eeccac 96 */
nxp_ip 0:a624e2eeccac 97 PCA9955A( PinName i2c_sda, PinName i2c_scl, char i2c_address = PCA995xA::DEFAULT_I2C_ADDR );
nxp_ip 0:a624e2eeccac 98
nxp_ip 0:a624e2eeccac 99 /** Create a PCA9629A instance connected to specified I2C pins with specified address
nxp_ip 0:a624e2eeccac 100 *
nxp_ip 0:a624e2eeccac 101 * @param i2c_obj I2C object (instance)
nxp_ip 0:a624e2eeccac 102 * @param i2c_address (option) I2C-bus address (default: 0xC0)
nxp_ip 0:a624e2eeccac 103 */
nxp_ip 0:a624e2eeccac 104 PCA9955A( I2C &i2c_obj, char i2c_address = PCA995xA::DEFAULT_I2C_ADDR );
nxp_ip 0:a624e2eeccac 105
nxp_ip 0:a624e2eeccac 106 /** Destractor
nxp_ip 0:a624e2eeccac 107 *
nxp_ip 0:a624e2eeccac 108 */
nxp_ip 0:a624e2eeccac 109 virtual ~PCA9955A();
nxp_ip 0:a624e2eeccac 110
nxp_ip 0:a624e2eeccac 111 /** Returns the number of output ports
nxp_ip 0:a624e2eeccac 112 *
nxp_ip 0:a624e2eeccac 113 * @returns
nxp_ip 0:a624e2eeccac 114 * The number of output ports
nxp_ip 0:a624e2eeccac 115 */
nxp_ip 0:a624e2eeccac 116 virtual int number_of_ports( void );
nxp_ip 0:a624e2eeccac 117
nxp_ip 0:a624e2eeccac 118 #if DOXYGEN_ONLY
nxp_ip 0:a624e2eeccac 119 /** Set the output duty-cycle, specified as a percentage (float)
nxp_ip 0:a624e2eeccac 120 *
nxp_ip 0:a624e2eeccac 121 * @param port Selecting output port
nxp_ip 0:a624e2eeccac 122 * 'ALLPORTS' can be used to set all port duty-cycle same value.
nxp_ip 0:a624e2eeccac 123 * @param v A floating-point value representing the output duty-cycle,
nxp_ip 0:a624e2eeccac 124 * specified as a percentage. The value should lie between
nxp_ip 0:a624e2eeccac 125 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
nxp_ip 0:a624e2eeccac 126 * Values outside this range will have undefined behavior.
nxp_ip 0:a624e2eeccac 127 */
nxp_ip 0:a624e2eeccac 128 void pwm( int port, float v );
nxp_ip 0:a624e2eeccac 129
nxp_ip 0:a624e2eeccac 130 /** Set all output port duty-cycle, specified as a percentage (array of float)
nxp_ip 0:a624e2eeccac 131 *
nxp_ip 0:a624e2eeccac 132 * @param vp Aray to floating-point values representing the output duty-cycle,
nxp_ip 0:a624e2eeccac 133 * specified as a percentage. The value should lie between
nxp_ip 0:a624e2eeccac 134 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
nxp_ip 0:a624e2eeccac 135 *
nxp_ip 0:a624e2eeccac 136 * @note
nxp_ip 0:a624e2eeccac 137 * The aray should have length of 16
nxp_ip 0:a624e2eeccac 138 */
nxp_ip 0:a624e2eeccac 139 void pwm( float *vp );
nxp_ip 0:a624e2eeccac 140
nxp_ip 0:a624e2eeccac 141 /** Set the output current, specified as a percentage (float)
nxp_ip 0:a624e2eeccac 142 *
nxp_ip 0:a624e2eeccac 143 * @param port Selecting output port
nxp_ip 0:a624e2eeccac 144 * 'ALLPORTS' can be used to set all port duty-cycle same value.
nxp_ip 0:a624e2eeccac 145 * @param v A floating-point value representing the output current,
nxp_ip 0:a624e2eeccac 146 * specified as a percentage. The value should lie between
nxp_ip 0:a624e2eeccac 147 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
nxp_ip 0:a624e2eeccac 148 * Values outside this range will have undefined behavior.
nxp_ip 0:a624e2eeccac 149 */
nxp_ip 0:a624e2eeccac 150 void current( int port, float vp );
nxp_ip 0:a624e2eeccac 151
nxp_ip 0:a624e2eeccac 152 /** Set all output port curent, specified as a percentage (array of float)
nxp_ip 0:a624e2eeccac 153 *
nxp_ip 0:a624e2eeccac 154 * @param vp Aray to floating-point values representing the output current,
nxp_ip 0:a624e2eeccac 155 * specified as a percentage. The value should lie between
nxp_ip 0:a624e2eeccac 156 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
nxp_ip 0:a624e2eeccac 157 *
nxp_ip 0:a624e2eeccac 158 * @note
nxp_ip 0:a624e2eeccac 159 * The aray should have length of 16
nxp_ip 0:a624e2eeccac 160 */
nxp_ip 0:a624e2eeccac 161 void current( float *vP );
nxp_ip 0:a624e2eeccac 162
nxp_ip 0:a624e2eeccac 163 /** Register write (single byte) : Low level access to device register
nxp_ip 0:a624e2eeccac 164 *
nxp_ip 0:a624e2eeccac 165 * @param reg_addr Register address
nxp_ip 0:a624e2eeccac 166 * @param data Value for setting into the register
nxp_ip 0:a624e2eeccac 167 */
nxp_ip 0:a624e2eeccac 168 void write( char reg_addr, char data );
nxp_ip 0:a624e2eeccac 169
nxp_ip 0:a624e2eeccac 170 /** Register write (multiple bytes) : Low level access to device register
nxp_ip 0:a624e2eeccac 171 *
nxp_ip 0:a624e2eeccac 172 * @param data Pointer to an array. First 1 byte should be the writing start register address
nxp_ip 0:a624e2eeccac 173 * @param length Length of data
nxp_ip 0:a624e2eeccac 174 */
nxp_ip 0:a624e2eeccac 175 void write( char *data, int length );
nxp_ip 0:a624e2eeccac 176
nxp_ip 0:a624e2eeccac 177 /** Register read (single byte) : Low level access to device register
nxp_ip 0:a624e2eeccac 178 *
nxp_ip 0:a624e2eeccac 179 * @param reg_addr Register address
nxp_ip 0:a624e2eeccac 180 * @return Read value from register
nxp_ip 0:a624e2eeccac 181 */
nxp_ip 0:a624e2eeccac 182 char read( char reg_addr );
nxp_ip 0:a624e2eeccac 183
nxp_ip 0:a624e2eeccac 184 /** Register write (multiple bytes) : Low level access to device register
nxp_ip 0:a624e2eeccac 185 *
nxp_ip 0:a624e2eeccac 186 * @param reg_addr Register address
nxp_ip 0:a624e2eeccac 187 * @param data Pointer to an array. The values are stored in this array.
nxp_ip 0:a624e2eeccac 188 * @param length Length of data
nxp_ip 0:a624e2eeccac 189 */
nxp_ip 0:a624e2eeccac 190 void read( char reg_addr, char *data, int length );
nxp_ip 0:a624e2eeccac 191 #endif
nxp_ip 0:a624e2eeccac 192
nxp_ip 0:a624e2eeccac 193 /** Gradation control setting
nxp_ip 0:a624e2eeccac 194 *
nxp_ip 0:a624e2eeccac 195 * Auto calculation and register setting API for gradation control.
nxp_ip 0:a624e2eeccac 196 * User can set the gradation by specifying cycle, hold-ON/OFF time and ramp-up/down enabling.
nxp_ip 0:a624e2eeccac 197 * All register values are calcurated automatically to have fine gradation setting.
nxp_ip 0:a624e2eeccac 198 * In this routine, the IREF (current) setting is fixed to maximum (i.e. 0xFF)
nxp_ip 0:a624e2eeccac 199 *
nxp_ip 0:a624e2eeccac 200 * @param group Group selector
nxp_ip 0:a624e2eeccac 201 * @param cycle Ramp rate register (RAMP_RATE_GRPn) value
nxp_ip 0:a624e2eeccac 202 * @param flag_on Holding time for ON can be selected from available constants.
nxp_ip 0:a624e2eeccac 203 * Those are 0, 0.25, 0.5, 0.75, 1, 2, 4 and 6 seconds.
nxp_ip 0:a624e2eeccac 204 * Use one of next words: HOLD_0_00_SEC, HOLD_0_25_SEC, HOLD_0_50_SEC, HOLD_0_75_SEC, HOLD_1_00_SEC, HOLD_2_00_SEC, HOLD_4_00_SEC or HOLD_6_00_SEC
nxp_ip 0:a624e2eeccac 205 * @param flag_off Holding time for OFF can be selected from available constants.
nxp_ip 0:a624e2eeccac 206 * Those are 0, 0.25, 0.5, 0.75, 1, 2, 4 and 6 seconds.
nxp_ip 0:a624e2eeccac 207 * Use one of next words: HOLD_0_00_SEC, HOLD_0_25_SEC, HOLD_0_50_SEC, HOLD_0_75_SEC, HOLD_1_00_SEC, HOLD_2_00_SEC, HOLD_4_00_SEC or HOLD_6_00_SEC
nxp_ip 0:a624e2eeccac 208 * @param ramp_flag Choose one from next words : NO_RAMP, RAMP_UP_ONLY, RAMP_DOWN_ONLY or RAMP_UP_DOWN
nxp_ip 0:a624e2eeccac 209 *
nxp_ip 0:a624e2eeccac 210 * @return calculated actual time for one cycle (in seconds)
nxp_ip 0:a624e2eeccac 211 *
nxp_ip 0:a624e2eeccac 212 * @see gradation_setting()
nxp_ip 0:a624e2eeccac 213 */
nxp_ip 0:a624e2eeccac 214 float gradation_ramp_setting( char group, float cycle, char flag_on, char flag_off, int ramp_flag );
nxp_ip 0:a624e2eeccac 215
nxp_ip 0:a624e2eeccac 216 /** Gradation control: Port assignment to group
nxp_ip 0:a624e2eeccac 217 *
nxp_ip 0:a624e2eeccac 218 * Each ports which is going to use in gradation control should be assigned to group.
nxp_ip 0:a624e2eeccac 219 * This function help to assign the port to 1 of 4 groups.
nxp_ip 0:a624e2eeccac 220 *
nxp_ip 0:a624e2eeccac 221 * @param group Target group
nxp_ip 0:a624e2eeccac 222 * @param port A output port which is being assigned to the target group
nxp_ip 0:a624e2eeccac 223 */
nxp_ip 0:a624e2eeccac 224 void gradation_group_setting( char group, char port );
nxp_ip 0:a624e2eeccac 225
nxp_ip 0:a624e2eeccac 226 /** Gradation control: Start
nxp_ip 0:a624e2eeccac 227 *
nxp_ip 0:a624e2eeccac 228 * @param group Group selector
nxp_ip 0:a624e2eeccac 229 * @param continuous_flag (option) Set false for one-shot operation
nxp_ip 0:a624e2eeccac 230 */
nxp_ip 0:a624e2eeccac 231 void gradation_start( char group, char continuous_flag = true );
nxp_ip 0:a624e2eeccac 232
nxp_ip 0:a624e2eeccac 233 /** Gradation control: Stop
nxp_ip 0:a624e2eeccac 234 *
nxp_ip 0:a624e2eeccac 235 */
nxp_ip 0:a624e2eeccac 236 void gradation_stop( void );
nxp_ip 0:a624e2eeccac 237
nxp_ip 0:a624e2eeccac 238
nxp_ip 0:a624e2eeccac 239 /** Gradation control: Clear all group assignments
nxp_ip 0:a624e2eeccac 240 *
nxp_ip 0:a624e2eeccac 241 * Set all output port operation to no-gradation control
nxp_ip 0:a624e2eeccac 242 *
nxp_ip 0:a624e2eeccac 243 */
nxp_ip 0:a624e2eeccac 244 void gradation_group_clear( void );
nxp_ip 0:a624e2eeccac 245
nxp_ip 0:a624e2eeccac 246 /** Setting gradation control registers (low level setting API)
nxp_ip 0:a624e2eeccac 247 *
nxp_ip 0:a624e2eeccac 248 * @param group Group selector
nxp_ip 0:a624e2eeccac 249 * @param ramp_rate Ramp rate register (RAMP_RATE_GRPn) value
nxp_ip 0:a624e2eeccac 250 * @param step_time Step time register (STEP_TIME_GRPn) value
nxp_ip 0:a624e2eeccac 251 * @param hold_cntl Hold control register (HOLD_CNTL_GRPn) value
nxp_ip 0:a624e2eeccac 252 * @param iref IREF (current setting) register (IREF_GRPn) value
nxp_ip 0:a624e2eeccac 253 *
nxp_ip 0:a624e2eeccac 254 * @see gradation_ramp_setting()
nxp_ip 0:a624e2eeccac 255 */
nxp_ip 0:a624e2eeccac 256 void gradation_setting( int group, char ramp_rate, char step_time, char hold_cntl, char iref );
nxp_ip 0:a624e2eeccac 257
nxp_ip 0:a624e2eeccac 258 /** Setting gradation register dump (for debugging)
nxp_ip 0:a624e2eeccac 259 *
nxp_ip 0:a624e2eeccac 260 */
nxp_ip 0:a624e2eeccac 261 void dump_gradation_registers( void );
nxp_ip 0:a624e2eeccac 262
nxp_ip 0:a624e2eeccac 263 private:
nxp_ip 0:a624e2eeccac 264 void initialize( void );
nxp_ip 0:a624e2eeccac 265 virtual char pwm_register_access( int port );
nxp_ip 0:a624e2eeccac 266 virtual char current_register_access( int port );
nxp_ip 0:a624e2eeccac 267
nxp_ip 0:a624e2eeccac 268 void group_selector( short g0, short g1, short g2, short g3 );
nxp_ip 0:a624e2eeccac 269
nxp_ip 0:a624e2eeccac 270 const int n_of_ports;
nxp_ip 0:a624e2eeccac 271 static char gradation_group[];
nxp_ip 0:a624e2eeccac 272 }
nxp_ip 0:a624e2eeccac 273 ;
nxp_ip 0:a624e2eeccac 274
nxp_ip 0:a624e2eeccac 275 /** Constants for Gradation control */
nxp_ip 0:a624e2eeccac 276 enum GradationControlConstants {
nxp_ip 0:a624e2eeccac 277 CONTINUOUS = 1,
nxp_ip 0:a624e2eeccac 278 NOGROUP = 0xFF
nxp_ip 0:a624e2eeccac 279 };
nxp_ip 0:a624e2eeccac 280
nxp_ip 0:a624e2eeccac 281 /** Flags for Gradation control (Ramp selector) */
nxp_ip 0:a624e2eeccac 282 enum GradationControlRampSelector {
nxp_ip 0:a624e2eeccac 283 NO_RAMP = 0x0,
nxp_ip 0:a624e2eeccac 284 RAMP_UP_ONLY,
nxp_ip 0:a624e2eeccac 285 RAMP_DOWN_ONLY,
nxp_ip 0:a624e2eeccac 286 RAMP_UP_DOWN
nxp_ip 0:a624e2eeccac 287 };
nxp_ip 0:a624e2eeccac 288
nxp_ip 0:a624e2eeccac 289 /** Flags for Gradation control (Hold time selector) */
nxp_ip 0:a624e2eeccac 290 enum GradationControlHoldTimeSelector {
nxp_ip 0:a624e2eeccac 291 HOLD_0_00_SEC = 0x0,
nxp_ip 0:a624e2eeccac 292 HOLD_0_25_SEC,
nxp_ip 0:a624e2eeccac 293 HOLD_0_50_SEC,
nxp_ip 0:a624e2eeccac 294 HOLD_0_75_SEC,
nxp_ip 0:a624e2eeccac 295 HOLD_1_00_SEC,
nxp_ip 0:a624e2eeccac 296 HOLD_2_00_SEC,
nxp_ip 0:a624e2eeccac 297 HOLD_4_00_SEC,
nxp_ip 0:a624e2eeccac 298 HOLD_6_00_SEC
nxp_ip 0:a624e2eeccac 299 };
nxp_ip 0:a624e2eeccac 300
nxp_ip 0:a624e2eeccac 301 #endif // MBED_PCA9955A