stm32_pins.cpp File Reference

Detailed Description

STM32-compatible GPIO code.

Date

Jun 02, 2019

Author

Andrey Belomutskiy, (c) 2012-2020

Definition in file stm32_pins.cpp.

Functions
int	getBrainPinIndex (brain_pin_e brainPin)
ioportid_t	getBrainPinPort (brain_pin_e brainPin)
const char *	portname (ioportid_t port)
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 size, brain_pin_e brainPin)

Variables
static const struct port_io	ports []
static const char *	od_names [2] = { "Push-Pull", "Open-Drain" }
static const char *	speed_names [4] = { "Low", "Medium", "High", "Very High" }
static const char *	pull_names [4] = { "No pull", "Pull-up", "Pull-down", "Reserved" }

Function Documentation

debugBrainPin()

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

Definition at line 164 of file stm32_pins.cpp.

                                                                    {
    ioportid_t port = getBrainPinPort(brainPin);
    int pin = getBrainPinIndex(brainPin);
 
    if (port == nullptr) {
        buffer[0] = '\0';
        return;
    }
 
    uint32_t mode = (port->MODER >> (pin * 2)) & 0x03;
 
    if (mode == 0) {
        chsnprintf(buffer, size, "Input %s IN %d",
                pull_names[(port->PUPDR >> (pin * 2)) & 0x03],
                (port->IDR >> pin) & 0x01);
    } else if (mode == 1) {
        chsnprintf(buffer, size, "GP out %s %s Speed %s OUT %d IN %d",
                od_names[(port->OTYPER >> pin) & 0x01],
                pull_names[(port->PUPDR >> (pin * 2)) & 0x03],
                speed_names[(port->OSPEEDR >> (pin * 2)) & 0x03],
                (port->ODR >> pin) & 0x01,
                (port->IDR >> pin) & 0x01);     
    } else if (mode == 2) {
        uint32_t af = (pin < 8) ? port->AFRL : port->AFRH;
        af = (af >> (4 * (pin & 0x07))) & 0x0f;
        chsnprintf(buffer, size, "Mode AF%d %s %s Speed %s IN %d OUT %d",
                af,
                od_names[(port->OTYPER >> pin) & 0x01],
                pull_names[(port->PUPDR >> (pin * 2)) & 0x03],
                speed_names[(port->OSPEEDR >> (pin * 2)) & 0x03],
                (port->IDR >> pin) & 0x01,
                (port->ODR >> pin) & 0x01);
    } else if (mode == 3) {
        chsnprintf(buffer, size, "Mode Analog");
    }
}

Referenced by reportPins().

Here is the call graph for this function:

Here is the caller graph for this function:

getBrainPinIndex()

int getBrainPinIndex

(

brain_pin_e

brainPin

)

Definition at line 48 of file stm32_pins.cpp.

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

Referenced by boardInitMfs(), debugBrainPin(), detectHellenBoardId(), getHwPin(), HellenBoardIdFinder< NumPins >::measureChargingTimes(), and reportPins().

Here is the caller graph for this function:

getBrainPinOnchipNum()

unsigned int getBrainPinOnchipNum

(

void

)

Definition at line 156 of file stm32_pins.cpp.

                                        {
    return BRAIN_PIN_ONCHIP_PINS;
}

Referenced by reportPins().

Here is the caller graph for this function:

getBrainPinPort()

ioportid_t getBrainPinPort

(

brain_pin_e

brainPin

)

Definition at line 52 of file stm32_pins.cpp.

                                                 {
    size_t idx = (brainPin - Gpio::A0) / PORT_SIZE;
    if (idx < efi::size(ports)) {
        return ports[idx].port;
    }
 
    return nullptr;
}

Referenced by boardInitMfs(), debugBrainPin(), detectHellenBoardId(), HellenBoardIdFinder< NumPins >::measureChargingTimes(), and reportPins().

Here is the call graph for this function:

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 115 of file stm32_pins.cpp.

                                                             {
    if (!isBrainPinValid(brainPin))
            return EFI_ERROR_CODE;
 
    if (brain_pin_is_onchip(brainPin))
        return getBrainPinIndex(brainPin);
 
 
// huh why conditional on EFI_BOOTLOADER? some weird technical debt while does it fail only with debug options?
#ifndef EFI_BOOTLOADER
    criticalError("%s: Invalid on-chip Gpio: %d", msg, (int)brainPin);
#endif // EFI_BOOTLOADER
    return EFI_ERROR_CODE;
}

Referenced by adcTriggerTurnOnInputPin(), benchSetPinValue(), directWritePad(), efiExtiDisablePin(), efiExtiEnablePin(), efiReadPin(), efiSetPadMode(), efiSetPadModeWithoutOwnershipAcquisition(), efiSetPadUnused(), extiTriggerTurnOnInputPin(), getAdcChannelPin(), hwPhysicalPinName(), BitbangI2c::init(), initAccelerometer(), initErrorLed(), initializeMmcBlockDevice(), OutputPin::initPin(), initQcBenchControls(), initSmartGpio(), initSpiCsNoOccupy(), initWave(), lua_readpin(), readPin(), and writePad().

Here is the call graph for this function:

Here is the caller graph for this function:

getHwPort()

ioportid_t getHwPort	(	const char *	msg,
		brain_pin_e	brainPin
	)

Definition at line 90 of file stm32_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;
    }
    size_t idx = (brainPin - Gpio::A0) / PORT_SIZE;
    if (idx < efi::size(ports)) {
        return ports[idx].port;
    }
 
#ifndef EFI_BOOTLOADER
    firmwareError(ObdCode::CUSTOM_ERR_UNKNOWN_PORT, "unknown port");
#endif
 
    return nullptr;
}

Referenced by adcTriggerTurnOnInputPin(), benchSetPinValue(), directWritePad(), efiExtiDisablePin(), efiExtiEnablePin(), efiReadPin(), efiSetPadMode(), efiSetPadModeWithoutOwnershipAcquisition(), efiSetPadUnused(), extiTriggerTurnOnInputPin(), getAdcChannelPort(), hwPhysicalPinName(), BitbangI2c::init(), initAccelerometer(), initErrorLed(), initializeMmcBlockDevice(), OutputPin::initPin(), initQcBenchControls(), initSmartGpio(), initSpiCsNoOccupy(), initWave(), lua_readpin(), readPin(), and writePad().

Here is the call graph for this function:

Here is the caller graph for this function:

getPortIndex()

static int getPortIndex ( ioportid_t  port )

static

Definition at line 71 of file stm32_pins.cpp.

                                         {
    for (size_t idx = 0; idx < efi::size(ports); idx++) {
        if (ports[idx].port == port) {
            return idx;
        }
    }
 
#ifndef EFI_BOOTLOADER
    firmwareError(ObdCode::CUSTOM_ERR_UNKNOWN_PORT, "unknown port");
#endif
 
    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 85 of file stm32_pins.cpp.

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

Referenced by gpio_pin_markUnused(), and gpio_pin_markUsed().

Here is the call graph for this function:

Here is the caller 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 135 of file stm32_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 (brain_pin_e)(basePin + pin);
}

Referenced by lua_readpin(), and parseBrainPinWithErrorMessage().

Here is the caller graph for this function:

portname()

const char * portname

(

ioportid_t

port

)

Deprecated:

• use hwPortname() instead

Deprecated:

• use hwPortname() instead

Definition at line 61 of file stm32_pins.cpp.

                                      {
    efiAssert(ObdCode::CUSTOM_ERR_ASSERT, port != NULL, "null port", nullptr);
    for (size_t idx = 0; idx < efi::size(ports); idx++) {
        if (ports[idx].port == port) {
            return ports[idx].name;
        }
    }
    return "unknown";
}

Referenced by adcPrintChannelReport(), getPinNameByAdcChannel(), gpio_pin_markUsed(), hwOnChipPhysicalPinName(), and reportPins().

Here is the caller graph for this function:

Variable Documentation

od_names

const char* od_names[2] = { "Push-Pull", "Open-Drain" }

static

Definition at line 160 of file stm32_pins.cpp.

{ "Push-Pull", "Open-Drain" };

Referenced by debugBrainPin().

ports

const struct port_io ports[]

static

Initial value:

= {
    { GPIOA, "PA" },
    { GPIOB, "PB" },
    { GPIOC, "PC" },
    { GPIOD, "PD" },
#if STM32_HAS_GPIOE
    { GPIOE, "PE" },
#endif 
#if STM32_HAS_GPIOF
    { GPIOF, "PF" },
#endif 
#if STM32_HAS_GPIOG
    { GPIOG, "PG" },
#endif 
#if STM32_HAS_GPIOH
    { GPIOH, "PH" },
#endif 
#if STM32_HAS_GPIOI
    { GPIOI, "PI" },
#endif 
#if STM32_HAS_GPIOJ
    { GPIOJ, "PJ" },
#endif 
#if STM32_HAS_GPIOK
    { GPIOK, "PK" },
#endif 
}

Referenced by getBrainPinPort(), getHwPort(), getPortIndex(), and portname().

pull_names

const char* pull_names[4] = { "No pull", "Pull-up", "Pull-down", "Reserved" }

static

Definition at line 162 of file stm32_pins.cpp.

{ "No pull", "Pull-up", "Pull-down", "Reserved" };

Referenced by debugBrainPin().

speed_names

const char* speed_names[4] = { "Low", "Medium", "High", "Very High" }

static

Definition at line 161 of file stm32_pins.cpp.

{ "Low", "Medium", "High", "Very High" };

Referenced by debugBrainPin().

Go to the source code of this file.