GPIOMSP432E4.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2019, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_GPIOMSP432E4__include
#define ti_drivers_GPIOMSP432E4__include

#include <stdint.h>

#include <ti/devices/msp432e4/inc/msp432.h>

#include <ti/devices/msp432e4/driverlib/gpio.h>

#include <ti/drivers/GPIO.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    GPIO_PinConfig *pinConfigs;

    GPIO_CallbackFxn *callbacks;

    uint32_t numberOfPinConfigs;

    uint32_t numberOfCallbacks;

    uint32_t intPriority;
} GPIOMSP432E4_Config;

/*
 *  Note that the port Ids (0x10 and 0x11) for Ports P and Q are out of
 *  sequence.  This is to facilitate access to the interrupt vector
 *  table in the implementation.  Each pin on ports P and Q has a dedicated
 *  interrupt vector.
 */
#define GPIOMSP432E4_PORTA 0x00
#define GPIOMSP432E4_PORTB 0x01
#define GPIOMSP432E4_PORTC 0x02
#define GPIOMSP432E4_PORTD 0x03
#define GPIOMSP432E4_PORTE 0x04
#define GPIOMSP432E4_PORTF 0x05
#define GPIOMSP432E4_PORTG 0x06
#define GPIOMSP432E4_PORTH 0x07
#define GPIOMSP432E4_PORTJ 0x08
#define GPIOMSP432E4_PORTK 0x09
#define GPIOMSP432E4_PORTL 0x0A
#define GPIOMSP432E4_PORTM 0x0B
#define GPIOMSP432E4_PORTN 0x0C
#define GPIOMSP432E4_PORTP 0x10
#define GPIOMSP432E4_PORTQ 0x11
#define GPIOMSP432E4_PORTR 0x0D
#define GPIOMSP432E4_PORTS 0x0E
#define GPIOMSP432E4_PORTT 0x0F

#define GPIOMSP432E4_EMPTY_PIN 0x0000

#define GPIOMSP432E4_PA0      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PA1      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PA2      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PA3      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PA4      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PA5      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PA6      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PA7      ((GPIOMSP432E4_PORTA << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PB0      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PB1      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PB2      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PB3      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PB4      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PB5      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PB6      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PB7      ((GPIOMSP432E4_PORTB << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PC0      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PC1      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PC2      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PC3      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PC4      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PC5      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PC6      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PC7      ((GPIOMSP432E4_PORTC << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PD0      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PD1      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PD2      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PD3      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PD4      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PD5      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PD6      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PD7      ((GPIOMSP432E4_PORTD << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PE0      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PE1      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PE2      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PE3      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PE4      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PE5      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PE6      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PE7      ((GPIOMSP432E4_PORTE << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PF0      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PF1      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PF2      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PF3      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PF4      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PF5      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PF6      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PF7      ((GPIOMSP432E4_PORTF << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PG0      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PG1      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PG2      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PG3      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PG4      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PG5      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PG6      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PG7      ((GPIOMSP432E4_PORTG << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PH0      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PH1      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PH2      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PH3      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PH4      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PH5      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PH6      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PH7      ((GPIOMSP432E4_PORTH << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PJ0      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PJ1      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PJ2      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PJ3      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PJ4      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PJ5      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PJ6      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PJ7      ((GPIOMSP432E4_PORTJ << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PK0      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PK1      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PK2      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PK3      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PK4      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PK5      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PK6      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PK7      ((GPIOMSP432E4_PORTK << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PL0      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PL1      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PL2      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PL3      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PL4      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PL5      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PL6      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PL7      ((GPIOMSP432E4_PORTL << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PM0      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PM1      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PM2      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PM3      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PM4      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PM5      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PM6      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PM7      ((GPIOMSP432E4_PORTM << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PN0      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PN1      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PN2      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PN3      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PN4      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PN5      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PN6      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PN7      ((GPIOMSP432E4_PORTN << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PP0      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PP1      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PP2      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PP3      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PP4      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PP5      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PP6      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PP7      ((GPIOMSP432E4_PORTP << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PQ0      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PQ1      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PQ2      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PQ3      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PQ4      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PQ5      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PQ6      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PQ7      ((GPIOMSP432E4_PORTQ << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PR0      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PR1      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PR2      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PR3      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PR4      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PR5      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PR6      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PR7      ((GPIOMSP432E4_PORTR << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PS0      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PS1      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PS2      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PS3      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_3)
#define GPIOMSP432E4_PS4      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_4)
#define GPIOMSP432E4_PS5      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_5)
#define GPIOMSP432E4_PS6      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_6)
#define GPIOMSP432E4_PS7      ((GPIOMSP432E4_PORTS << 8) | GPIO_PIN_7)

#define GPIOMSP432E4_PT0      ((GPIOMSP432E4_PORTT << 8) | GPIO_PIN_0)
#define GPIOMSP432E4_PT1      ((GPIOMSP432E4_PORTT << 8) | GPIO_PIN_1)
#define GPIOMSP432E4_PT2      ((GPIOMSP432E4_PORTT << 8) | GPIO_PIN_2)
#define GPIOMSP432E4_PT3      ((GPIOMSP432E4_PORTT << 8) | GPIO_PIN_3)

/*
 *  GPIO_Pxx_xxxx defines (driverlib/pin_map.h) don't use the upper 12
 *  bits of the mask.  We'll encode the port and pin ids in the top 8 bits
 *  and the GPIO_Pxx_xxxxx in the lower 24 bits of the following masks.
 */
#define GPIOMSP432E4_pinConfigMask(port, pin, mapping) \
    (((port) << 27) | ((pin) << 24) | ((mapping) & 0x00FFFFFF))

/*
 *  Macros to decode the pinConfigMask from above.
 */
#define GPIOMSP432E4_getPortFromPinConfig(config) (((config) >> 27) & 0x1F)
#define GPIOMSP432E4_getPinFromPinConfig(config) (1 << (((config) >> 24) & 0x7))
#define GPIOMSP432E4_getPinMapFromPinConfig(config) ((config) & 0xFFFFFF)

uint32_t GPIOMSP432E4_getGpioBaseAddr(uint8_t port);

uint_fast16_t GPIOMSP432E4_getPowerResourceId(uint8_t port);

void GPIOMSP432E4_undoPinConfig(uint32_t pinConfig);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_GPIOMSP432E4__include */