Data Structures
struct	GpioChip

Functions
int	gpiochips_getPinOffset (brain_pin_e pin)

const char *	gpiochips_getChipName (brain_pin_e pin)
	Get external chip name.

const char *	gpiochips_getPinName (brain_pin_e pin)
	Get external chip port name.

int	gpiochip_register (brain_pin_e base, const char *name, GpioChip &chip, size_t size)
	Register gpiochip.

int	gpiochips_setPinNames (brain_pin_e base, const char **names)
	Set pins names for registered gpiochip.

int	gpiochips_init (void)
	Init all registered gpiochips.

int	gpiochips_setPadMode (brain_pin_e pin, iomode_t mode)
	Set pin mode of gpiochip.

int	gpiochips_writePad (brain_pin_e pin, int value)
	Set value to gpio of gpiochip.

int	gpiochips_readPad (brain_pin_e pin)
	Get value to gpio of gpiochip.

brain_pin_diag_e	gpiochips_getDiag (brain_pin_e pin)
	Get diagnostic for given gpio.

void	gpiochips_debug ()

hardware_pwm *	gpiochip_tryInitPwm (const char *msg, brain_pin_e pin, float frequency, float duty)
	Try to init PWM on given pin.

int	gpiochips_get_total_pins (void)
	Get total pin count allocated for external gpio chips.

Function Documentation

◆ gpiochip_register()

int gpiochip_register	(	brain_pin_e	base,
		const char *	name,
		GpioChip &	gpioChip,
		size_t	size
	)

Register gpiochip.

should be called from board file. Can be called before os ready. All chips should be registered before gpiochips_init() called. returns -101 in case of no free chips left returns -100 in case of no ops provided, incorrect chip size returns -102 or -103 in case chip overlaps already registered chip(s) else returns chip base

Definition at line 186 of file core.cpp.

                                                                                           {
    /* zero size? */
    if (!size)
        return -100;
 
    /* outside? */
    if ((base + size - 1 > BRAIN_PIN_LAST) || (base <= BRAIN_PIN_ONCHIP_LAST))
        return -101;
 
    /* check for overlap with other chips */
    for (int i = 0; i < BOARD_EXT_GPIOCHIPS; i++) {
        if (chips[i].base != Gpio::Unassigned) {
            #define in_range(a, b, c)   (((a) > (b)) && ((a) < (c)))
            if (in_range(base, chips[i].base, chips[i].base + chips[i].size))
                return -102;
            if (in_range(base + size, chips[i].base, chips[i].base + chips[i].size))
                return -103;
        }
    }
 
    gpiochip *chip = nullptr;
 
    /* find free gpiochip struct */
    for (int i = 0; i < BOARD_EXT_GPIOCHIPS; i++) {
        if (chips[i].base == Gpio::Unassigned) {
            chip = &chips[i];
            break;
        }
    }
 
    /* no free chips left */
    if (!chip) {
        return -104;
    }
 
    /* register chip */
    chip->name = name;
    chip->chip = &gpioChip;
    chip->base = base;
    chip->size = size;
    chip->gpio_names = nullptr;
 
    // TODO: this cast seems wrong?
    return (int)base;
}

Referenced by drv8860_add(), initCanGpioMsiobox(), l9779_add(), mc33810_add(), mc33972_add(), protectedGpio_add(), tle6240_add(), tle8888_add(), and tle9104_add().

Here is the caller graph for this function:

◆ gpiochip_tryInitPwm()

hardware_pwm * gpiochip_tryInitPwm	(	const char *	msg,
		brain_pin_e	pin,
		float	frequency,
		float	duty
	)

Try to init PWM on given pin.

success of call depends on chip capabilities returns nullptr in case there is no chip for given pin returns nullptr in case of pin is not PWM capable returns nullptr in case all extPwms are already used returns hardware_pwm if succes, later user can call ->setDuty to change duty

Definition at line 439 of file core.cpp.

{
    gpiochip *chip = gpiochip_find(pin);
 
    if (!chip) {
        return nullptr;
    }
 
    /* TODO: implement reintialization of same pin with different settings reusing same external_hardware_pwm */
    if (external_hardware_pwm *device = gpiochip_getNextPwmDevice()) {
        if (device->start(msg, chip, pin - chip->base, frequency, duty) >= 0) {
            return device;
        }
    }
 
    return nullptr;
}

Referenced by startSimplePwm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_debug()

void gpiochips_debug ( )

Definition at line 413 of file core.cpp.

{
    int i;
 
    for (i = 0; i < BOARD_EXT_GPIOCHIPS; i++) {
        gpiochip *chip = &chips[i];
 
        if (chip->base == Gpio::Unassigned)
            continue;
 
        efiPrintf("%s (base %d, size %d):\n", chip->name, (int)chip->base, chip->size);
        chip->chip->debug();
    }
}

Referenced by reportPins().

Here is the caller graph for this function:

◆ gpiochips_get_total_pins()

int gpiochips_get_total_pins ( void )

Get total pin count allocated for external gpio chips.

Will also include unused pins for chips that was registered but later fails to init.

Definition at line 396 of file core.cpp.

{
    int i;
    int cnt = 0;
 
    for (i = 0; i < BOARD_EXT_GPIOCHIPS; i++) {
        gpiochip *chip = &chips[i];
 
        if (chip->base == Gpio::Unassigned)
            continue;
 
        cnt += chip->size;
    }
 
    return cnt;
}

◆ gpiochips_getChipName()

const char * gpiochips_getChipName ( brain_pin_e pin )

Get external chip name.

return gpiochip name

Definition at line 148 of file core.cpp.

                                                   {
    gpiochip *chip = gpiochip_find(pin);
 
    if (chip)
        return chip->name;
 
    return nullptr;
}

Referenced by hwPhysicalPinName(), and reportPins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_getDiag()

brain_pin_diag_e gpiochips_getDiag ( brain_pin_e pin )

Get diagnostic for given gpio.

actual output value depend on gpiochip capabilities returns PIN_UNKNOWN in case of pin not belong to any gpio chip returns PIN_OK in case of chip does not support getting diagnostic else return brain_pin_diag_e from gpiochip driver;

Definition at line 381 of file core.cpp.

                                                    {
    gpiochip *chip = gpiochip_find(pin);
 
    if (!chip)
        return PIN_UNKNOWN;
 
    return chip->chip->getDiag(pin - chip->base);
}

Referenced by OutputPin::getDiag(), and reportPins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_getPinName()

const char * gpiochips_getPinName ( brain_pin_e pin )

Get external chip port name.

return pin name or gpiochip name (if no pins names provided)

Definition at line 162 of file core.cpp.

{
    int offset;
    gpiochip *chip = gpiochip_find(pin);
 
    if (chip) {
        offset = pin - chip->base;
        if ((chip->gpio_names) && (chip->gpio_names[offset]))
            return chip->gpio_names[offset];
    }
 
    return nullptr;
}

Referenced by hwPhysicalPinName(), and reportPins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_getPinOffset()

int gpiochips_getPinOffset ( brain_pin_e pin )

return numeric part of EXTERNAL pin name.

Definition at line 132 of file core.cpp.

{
    gpiochip *chip = gpiochip_find(pin);
 
    if (chip)
        return pin - chip->base;
 
    return EFI_ERROR_CODE;
}

Referenced by hwPhysicalPinName(), and reportPins().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_init()

int gpiochips_init ( void )

Init all registered gpiochips.

will call gpiochip init ops for all registered chips calles when OS is ready, so gpiochip can start threads, use drivers and so on.

Definition at line 284 of file core.cpp.

                         {
    int pins_added = 0;
 
    for (int i = 0; i < BOARD_EXT_GPIOCHIPS; i++) {
        gpiochip *chip = &chips[i];
 
        if (chip->base == Gpio::Unassigned)
            continue;
 
    int ret = chip->chip->init();
        if (ret < 0) {
            #if EFI_PROD_CODE
                // todo: adjust unit tests to validate this fatal
                criticalError("Failed to init chip %d: %d", i, ret);
            #else
                chip->base = Gpio::Unassigned;
      #endif
        } else {
            pins_added += chip->size;
        }
    }
 
    return pins_added;
}

Referenced by initSmartGpio().

Here is the caller graph for this function:

◆ gpiochips_readPad()

int gpiochips_readPad ( brain_pin_e pin )

Get value to gpio of gpiochip.

actual input value depent on current gpiochip implementation returns -1 in case of pin not belong to any gpio chip returns -1 in case of chip does not support getting output value (output only) else return value from gpiochip driver;

Definition at line 363 of file core.cpp.

{
    gpiochip *chip = gpiochip_find(pin);
 
    if (!chip)
        return -109;
 
    return chip->chip->readPad(pin - chip->base);
}

Referenced by efiReadPin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_setPadMode()

int gpiochips_setPadMode	(	brain_pin_e	pin,
		iomode_t	mode
	)

Set pin mode of gpiochip.

set pad mode for given pin. return -107 if driver does not implemet setPadMode ops else return value from gpiochip driver.

Definition at line 317 of file core.cpp.

{
    gpiochip *chip = gpiochip_find(pin);
 
    if (!chip)
        return -107;
 
    return chip->chip->setPadMode(pin - chip->base, mode);
}

Referenced by efiSetPadModeWithoutOwnershipAcquisition(), and efiSetPadUnused().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_setPinNames()

int gpiochips_setPinNames	(	brain_pin_e	base,
		const char **	names
	)

Set pins names for registered gpiochip.

should be called after chip registration. May be called several times Names array size should be aqual to chip gpio count

Definition at line 266 of file core.cpp.

{
    gpiochip *chip = gpiochip_find(base);
 
    if (!chip)
        return -113;
 
    chip->gpio_names = names;
 
    return 0;
}

Referenced by drv8860_add(), l9779_add(), mc33810_add(), tle6240_add(), and tle8888_add().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gpiochips_writePad()

int gpiochips_writePad	(	brain_pin_e	pin,
		int	value
	)

Set value to gpio of gpiochip.

actual output value depent on current gpiochip implementation for smart switch inactive supposed to be closed switch (no current flows) returns -1 in case of pin not belong to any gpio chip returns -1 in case of chip does not support seting output value (input only) else return value from gpiochip driver;

Definition at line 336 of file core.cpp.

                                                   {
#if EFI_PROD_CODE
extern bool isInHardFaultHandler;
  // todo: technical debt, how do we turn off smart GPIO?!
  if (isInHardFaultHandler) {
    return -130;
  }
#endif // EFI_PROD_CODE
    gpiochip *chip = gpiochip_find(pin);
 
    if (!chip) {
        // todo: make readPad fail in a similar way?
        criticalError("Failed migration? Time to reset settings? gpiochip not found for pin %d", pin);
        return -108;
    }
 
    return chip->chip->writePad(pin - chip->base, value);
}