kinetis_pins.cpp File Reference

Detailed Description

Kinetis-compatible GPIO code.

Date

Jun 02, 2019

Author

Andrey Belomutskiy, (c) 2012-2020

andreika prome.nosp@m.theu.nosp@m.s.pcb.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Definition in file kinetis_pins.cpp.

Functions
ioportid_t *	getGpioPorts ()
int	getBrainPinIndex (brain_pin_e brainPin)
ioportid_t	getBrainPinPort (brain_pin_e brainPin)
const char *	portname (ioportid_t GPIOx)
static int	getPortIndex (ioportid_t port)
int	getPortPinIndex (ioportid_t port, ioportmask_t pin)
ioportid_t	getHwPort (const char *msg, brain_pin_e brainPin)
ioportmask_t	getHwPin (const char *msg, brain_pin_e brainPin)
brain_pin_e	parseBrainPin (const char *str)
unsigned int	getBrainPinOnchipNum (void)
void	debugBrainPin (char *buffer, size_t, brain_pin_e)

Variables
static ioportid_t	ports []

Function Documentation

debugBrainPin()

void debugBrainPin	(	char *	buffer,
		size_t	size,
		brain_pin_e	brainPin
	)

Definition at line 180 of file kinetis_pins.cpp.

{
    buffer[0] = '\0';
}

getBrainPinIndex()

int getBrainPinIndex

(

brain_pin_e

brainPin

)

Definition at line 25 of file kinetis_pins.cpp.

                                           {
    return (brainPin - Gpio::A0) % PORT_SIZE;
}

Referenced by getHwPin().

Here is the caller graph for this function:

getBrainPinOnchipNum()

unsigned int getBrainPinOnchipNum

(

void

)

Definition at line 176 of file kinetis_pins.cpp.

                                        {
    return BRAIN_PIN_ONCHIP_PINS;
}

getBrainPinPort()

ioportid_t getBrainPinPort

(

brain_pin_e

brainPin

)

Definition at line 29 of file kinetis_pins.cpp.

                                                 {
    return getGpioPorts()[(brainPin - Gpio::A0) / PORT_SIZE];
}

Here is the call graph for this function:

getGpioPorts()

ioportid_t * getGpioPorts

(

)

Definition at line 21 of file kinetis_pins.cpp.

                            {
    return ports;
}

Referenced by getBrainPinPort(), and getHwPort().

Here is the caller graph for this function:

getHwPin()

ioportmask_t getHwPin	(	const char *	msg,
		brain_pin_e	brainPin
	)

this method returns the numeric part of pin name. For instance, for PC13 this would return '13'

Definition at line 139 of file kinetis_pins.cpp.

                                                             {
    if (!isBrainPinValid(brainPin))
            return EFI_ERROR_CODE;
 
    if (brain_pin_is_onchip(brainPin))
        return getBrainPinIndex(brainPin);
 
    firmwareError(ObdCode::CUSTOM_ERR_INVALID_PIN, "%s: Invalid on-chip Gpio: %d", msg, brainPin);
    return EFI_ERROR_CODE;
}

Here is the call graph for this function:

getHwPort()

ioportid_t getHwPort	(	const char *	msg,
		brain_pin_e	brainPin
	)

Definition at line 123 of file kinetis_pins.cpp.

                                                            {
    (void)msg;
 
    if (!isBrainPinValid(brainPin)) {
/*
 *  https://github.com/dron0gus please help
        firmwareError(ObdCode::CUSTOM_ERR_INVALID_PIN, "%s: Invalid Gpio: %d", msg, brainPin);
 */
        return nullptr;
    }
    return getGpioPorts()[(brainPin - Gpio::A0) / PORT_SIZE];
}

Here is the call graph for this function:

getPortIndex()

static int getPortIndex ( ioportid_t  port )

static

Definition at line 76 of file kinetis_pins.cpp.

                                         {
    efiAssert(ObdCode::CUSTOM_ERR_ASSERT, port != NULL, "null port", -1);
    if (port == GPIOA)
        return 0;
    if (port == GPIOB)
        return 1;
    if (port == GPIOC)
        return 2;
    if (port == GPIOD)
        return 3;
#if defined(GPIOF)
    if (port == GPIOE)
        return 4;
#endif /* GPIOE */
#if defined(GPIOF)
    if (port == GPIOF)
        return 5;
#endif /* GPIOF */
#if defined(GPIOG)
    if (port == GPIOG)
        return 6;
#endif /* GPIOG */
#if defined(GPIOH)
    if (port == GPIOH)
        return 7;
#endif /* GPIOH */
#if defined(GPIOI)
    if (port == GPIOI)
        return 8;
#endif /* STM32_HAS_GPIOI */
#if defined(GPIOJ_BASE)
    if (port == GPIOJ)
        return 9;
#endif /* GPIOJ_BASE */
#if defined(GPIOK_BASE)
    if (port == GPIOK)
        return 10;
#endif /* GPIOK_BASE */
    firmwareError(ObdCode::CUSTOM_ERR_UNKNOWN_PORT, "unknown port");
    return -1;
}

Referenced by getPortPinIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

getPortPinIndex()

int getPortPinIndex	(	ioportid_t	port,
		ioportmask_t	pin
	)

Definition at line 118 of file kinetis_pins.cpp.

                                                       {
    int portIndex = getPortIndex(port);
    return portIndex * PORT_SIZE + pin;
}

Here is the call graph for this function:

parseBrainPin()

brain_pin_e parseBrainPin

(

const char *

str

)

Parse string representation of physical pin into Gpio ordinal.

Returns

Gpio::Unassigned for "none", Gpio::Invalid for invalid entry

Definition at line 155 of file kinetis_pins.cpp.

                                           {
    if (strEqual(str, "none"))
        return Gpio::Unassigned;
    // todo: create method toLowerCase?
    if (str[0] != 'p' && str[0] != 'P') {
        return Gpio::Invalid;
    }
    char port = str[1];
    brain_pin_e basePin;
    if (port >= 'a' && port <= 'z') {
        basePin = (Gpio::A0 + PORT_SIZE * (port - 'a'));
    } else if (port >= 'A' && port <= 'Z') {
        basePin = (Gpio::A0 + PORT_SIZE * (port - 'A'));
    } else {
        return Gpio::Invalid;
    }
    const char *pinStr = str + 2;
    int pin = atoi(pinStr);
    return basePin + pin;
}

portname()

const char * portname

(

ioportid_t

GPIOx

)

Deprecated:

• use hwPortname() instead

Definition at line 36 of file kinetis_pins.cpp.

                                       {
    if (GPIOx == GPIOA)
        return "PA";
    if (GPIOx == GPIOB)
        return "PB";
    if (GPIOx == GPIOC)
        return "PC";
    if (GPIOx == GPIOD)
        return "PD";
#if defined(GPIOF)
    if (GPIOx == GPIOE)
        return "PE";
#endif /* GPIOE */
#if defined(GPIOF)
    if (GPIOx == GPIOF)
        return "PF";
#endif /* GPIOF */
#if defined(GPIOG)
    if (GPIOx == GPIOG)
        return "PG";
#endif /* GPIOG */
#if defined(GPIOH)
    if (GPIOx == GPIOH)
        return "PH";
#endif /* GPIOH */
#if defined(GPIOI)
    if (GPIOx == GPIOI)
        return "PI";
#endif /* GPIOI */
#if defined(GPIOJ_BASE)
    if (GPIOx == GPIOJ)
        return "PJ";
#endif /* GPIOJ_BASE */
#if defined(GPIOK_BASE)
    if (GPIOx == GPIOK)
        return "PK";
#endif /* GPIOK_BASE */
    return "unknown";
}

Variable Documentation

ports

ioportid_t ports[]

static

Initial value:

= {GPIOA,
        GPIOB,
        GPIOC,
        GPIOD,
        GPIOE
}

Definition at line 14 of file kinetis_pins.cpp.

                            {GPIOA,
        GPIOB,
        GPIOC,
        GPIOD,
        GPIOE
};

Referenced by getGpioPorts().

Go to the source code of this file.