pin_repository.h File Reference

Detailed Description

I/O pin registry header.

Date

Jan 15, 2013

Author

Andrey Belomutskiy, (c) 2012-2020

Definition in file pin_repository.h.

Functions
bool	isBrainPinValid (Gpio brainPin)
const char *	hwOnChipPhysicalPinName (ioportid_t hwPort, int hwPin)
void	initPinRepository ()
bool	brain_pin_is_onchip (Gpio brainPin)
bool	brain_pin_is_ext (Gpio brainPin)
void	pinDiag2string (char *buffer, size_t size, brain_pin_diag_e pin_diag)
bool	brain_pin_markUsed (brain_pin_e brainPin, const char *msg)
const char *	getPinFunction (brain_input_pin_e brainPin)
bool	gpio_pin_markUsed (ioportid_t port, ioportmask_t pin, const char *msg)
void	gpio_pin_markUnused (ioportid_t port, ioportmask_t pin)
int	getPortPinIndex (ioportid_t port, ioportmask_t pin)
ioportid_t	getBrainPinPort (brain_pin_e brainPin)
int	getBrainPinIndex (Gpio brainPin)
size_t	getBrainPinOnchipNum ()
const char *	hwPortname (Gpio brainPin)
const char *	hwPhysicalPinName (Gpio brainPin)
const char *	getBoardSpecificPinName (Gpio brainPin)
void	debugBrainPin (char *buffer, size_t size, brain_pin_e brainPin)
const char *&	getBrainUsedPin (size_t idx)

Function Documentation

brain_pin_is_ext()

bool brain_pin_is_ext

(

Gpio

brainPin

)

Definition at line 270 of file pin_repository.cpp.

{
    if (brainPin > BRAIN_PIN_ONCHIP_LAST)
        return true;
 
    return false;
}

Referenced by efiReadPin(), and startSimplePwm().

Here is the caller graph for this function:

brain_pin_is_onchip()

bool brain_pin_is_onchip

(

Gpio

brainPin

)

Definition at line 262 of file pin_repository.cpp.

{
    if ((brainPin < Gpio::A0) || (brainPin > BRAIN_PIN_ONCHIP_LAST))
        return false;
 
    return true;
}

Referenced by directWritePad(), efiReadPin(), efiSetPadModeWithoutOwnershipAcquisition(), efiSetPadUnused(), OutputPin::getDiag(), getHwPin(), hwPhysicalPinName(), and OutputPin::initPin().

Here is the caller graph for this function:

brain_pin_markUsed()

bool brain_pin_markUsed	(	Gpio	brainPin,
		const char *	msg
	)

Usually high-level code would invoke efiSetPadMode, not this method directly

See also brain_pin_markUnused()

Returns

true if this pin was already used, false otherwise

Definition at line 53 of file pin_repository.cpp.

                                                        {
#ifndef EFI_BOOTLOADER
//  efiPrintf("pin_markUsed: %s on %s", msg, hwPortname(brainPin));
#endif
 
    int index = brainPin_to_index(brainPin);
    if (index < 0)
        return true;
 
    if (pinRepository.getBrainUsedPin(index) != nullptr) {
        // hwPortname and share a buffer behind the scenes, even while they probably never use it for different
        // values here let's have an explicit second buffer to make this more reliable
        char physicalPinName[32];
        strncpy(physicalPinName, hwPhysicalPinName(brainPin), sizeof(physicalPinName) - 1);
        criticalError("Pin \"%s\" (%s) required by \"%s\" but is used by \"%s\"",
                hwPortname(brainPin),
                physicalPinName,
                msg,
                getBrainUsedPin(index));
        return true;
    }
 
    getBrainUsedPin(index) = msg;
    return false;
}

Referenced by efiSetPadMode().

Here is the call graph for this function:

Here is the caller graph for this function:

debugBrainPin()

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

Definition at line 199 of file cypress_pins.cpp.

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

Referenced by reportPins().

Here is the call graph for this function:

Here is the caller graph for this function:

getBoardSpecificPinName()

const char * getBoardSpecificPinName

(

Gpio

brainPin

)

Definition at line 7 of file generated_ts_name_by_pin.cpp.

                                                           {
    switch(brainPin) {
        case Gpio::B7: return "Injector 3Z";
        case Gpio::B8: return "Injector 3Y";
        case Gpio::B9: return "Injector 3W";
        case Gpio::C13: return "Injector 2M";
        case Gpio::C7: return "Coil 1H";
        case Gpio::C9: return "Coil 1F";
        case Gpio::D3: return "Injector 3U";
        case Gpio::D5: return "Injector 3X";
        case Gpio::D7: return "Injector 2N";
        case Gpio::D8: return "Coil 1O";
        case Gpio::D9: return "Coil 1P";
        case Gpio::E10: return "Coil 1I";
        case Gpio::E12: return "Coil 1M";
        case Gpio::E14: return "Coil 1G";
        case Gpio::E2: return "Injector 3V";
        case Gpio::E3: return "Injector 3S";
        case Gpio::E4: return "Injector 3T";
        case Gpio::E5: return "Injector 2O";
        case Gpio::E6: return "Injector 2P";
        case Gpio::E8: return "Coil 1L";
        default: return nullptr;
    }
    return nullptr;
}

Referenced by hwPortname(), printSentInfo(), and reportPins().

Here is the caller graph for this function:

getBrainPinIndex()

int getBrainPinIndex

(

Gpio

brainPin

)

Definition at line 39 of file cypress_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()

size_t getBrainPinOnchipNum

(

)

Definition at line 195 of file cypress_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 43 of file cypress_pins.cpp.

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

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:

getBrainUsedPin()

const char *& getBrainUsedPin

(

size_t

idx

)

Definition at line 20 of file pin_repository.cpp.

                                            {
    return pinRepository.getBrainUsedPin(index);
}

Referenced by brain_pin_markUnused(), brain_pin_markUsed(), getPinFunction(), gpio_pin_markUnused(), gpio_pin_markUsed(), and reportPins().

Here is the call graph for this function:

Here is the caller graph for this function:

getPinFunction()

const char * getPinFunction

(

brain_input_pin_e

brainPin

)

Definition at line 313 of file pin_repository.cpp.

                                                       {
    int index;
 
    index = brainPin_to_index(brainPin);
    if (index < 0)
        return NULL;
 
    return getBrainUsedPin(index);
}

Here is the call graph for this function:

getPortPinIndex()

int getPortPinIndex	(	ioportid_t	port,
		ioportmask_t	pin
	)

Definition at line 132 of file cypress_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:

gpio_pin_markUnused()

void gpio_pin_markUnused	(	ioportid_t	port,
		ioportmask_t	pin
	)

Marks on-chip gpio port-pin as UNused. Works only for on-chip gpios To be replaced with brain_pin_markUnused later

Definition at line 307 of file pin_repository.cpp.

                                                            {
    int index = getPortPinIndex(port, pin);
 
    getBrainUsedPin(index) = nullptr;
}

Referenced by BitbangI2c::deinit().

Here is the call graph for this function:

Here is the caller graph for this function:

gpio_pin_markUsed()

bool gpio_pin_markUsed	(	ioportid_t	port,
		ioportmask_t	pin,
		const char *	msg
	)

Marks on-chip gpio port-pin as used. Works only for on-chip gpios To be replaced with brain_pin_markUsed later

todo: the problem is that this warning happens before the console is even connected, so the warning is never displayed on the console and that's quite a problem!

Definition at line 283 of file pin_repository.cpp.

                                                                           {
    int index = getPortPinIndex(port, pin);
#ifndef EFI_BOOTLOADER
//  efiPrintf("pin_markUsed: %s on %s", msg, hwOnChipPhysicalPinName(port, pin));
#endif
 
    if (getBrainUsedPin(index) != NULL) {
        /**
         * todo: the problem is that this warning happens before the console is even
         * connected, so the warning is never displayed on the console and that's quite a problem!
         */
//      warning(ObdCode::OBD_PCM_Processor_Fault, "%s%d req by %s used by %s", portname(port), pin, msg, getBrainUsedPin(index));
        firmwareError(ObdCode::CUSTOM_ERR_PIN_ALREADY_USED_1, "%s%d req by %s used by %s", portname(port), (int)pin, msg, getBrainUsedPin(index));
        return true;
    }
    getBrainUsedPin(index) = msg;
    return false;
}

Referenced by hellen154hyundai_f7_boardInitHardware().

Here is the call graph for this function:

Here is the caller graph for this function:

hwOnChipPhysicalPinName()

const char * hwOnChipPhysicalPinName	(	ioportid_t	hwPort,
		int	hwPin
	)

Definition at line 199 of file pin_repository.cpp.

                                                                  {
  portNameStream.eos = 0; // reset
    if (!hwPort) {
        return "NONE";
    }
    chprintf((BaseSequentialStream *) &portNameStream, "%s%d", portname(hwPort), hwPin);
    portNameStream.buffer[portNameStream.eos] = 0; // need to terminate explicitly
  return portNameBuffer;
}

Referenced by hwPhysicalPinName().

Here is the call graph for this function:

Here is the caller graph for this function:

hwPhysicalPinName()

const char * hwPhysicalPinName

(

Gpio

brainPin

)

Definition at line 209 of file pin_repository.cpp.

                                             {
    if (brainPin == Gpio::Invalid) {
        return "INVALID";
    }
    if (brainPin == Gpio::Unassigned) {
        return "NONE";
    }
 
    if (brain_pin_is_onchip(brainPin)) {
        ioportid_t hwPort = getHwPort("hostname", brainPin);
        int hwPin = getHwPin("hostname", brainPin);
      return hwOnChipPhysicalPinName(hwPort, hwPin);
    }
    #if (BOARD_EXT_GPIOCHIPS > 0)
        else {
        portNameStream.eos = 0; // reset
            const char *pin_name = gpiochips_getPinName(brainPin);
 
            if (pin_name) {
                chprintf((BaseSequentialStream *) &portNameStream, "ext:%s",
                    pin_name);
            } else {
                chprintf((BaseSequentialStream *) &portNameStream, "ext:%s.%d",
                    gpiochips_getChipName(brainPin), gpiochips_getPinOffset(brainPin));
            }
        portNameStream.buffer[portNameStream.eos] = 0; // need to terminate explicitly
        return portNameBuffer;
        }
    #endif
  return "unexpected";
}

Referenced by brain_pin_markUsed(), and hwPortname().

Here is the call graph for this function:

Here is the caller graph for this function:

hwPortname()

const char * hwPortname

(

Gpio

brainPin

)

Definition at line 241 of file pin_repository.cpp.

                                             {
    const char * boardSpecificPinName = getBoardSpecificPinName(brainPin);
    if (boardSpecificPinName != nullptr) {
        return boardSpecificPinName;
    }
    return hwPhysicalPinName(brainPin);
}

Referenced by adcTriggerTurnOnInputPin(), benchSetPinValue(), brain_pin_markUsed(), canInfo(), OutputPin::deInit(), detectCanDevice(), doStartCranking(), efiExtiEnablePin(), extiTriggerTurnOnInputPin(), initElectronicThrottle(), OutputPin::initPin(), initQcBenchControls(), initWave(), onConfigurationChangeTriggerCallback(), printGpsInfo(), printMmcPinout(), printOutPin(), printSpiConfig(), printTsStats(), readPin(), runBench(), setIgnitionPin(), setIndividualPin(), setLogicInputPin(), setTriggerInputPin(), setTriggerSimulatorPin(), startCanPins(), startPwm(), triggerInfo(), and turnOnTriggerInputPin().

Here is the call graph for this function:

Here is the caller graph for this function:

initPinRepository()

void initPinRepository

(

)

this method cannot use console because this method is invoked before console is initialized

Definition at line 249 of file pin_repository.cpp.

                             {
    /**
     * this method cannot use console because this method is invoked before console is initialized
     */
 
    addConsoleAction(CMD_PINS, reportPins);
 
#if (BOARD_TLE8888_COUNT > 0)
    addConsoleAction("tle8888", tle8888_dump_regs);
    addConsoleAction("tle8888init", tle8888_req_init);
#endif
}

Referenced by initHardwareNoConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

isBrainPinValid()

bool isBrainPinValid

(

Gpio

brainPin

)

Definition at line 25 of file pin_repository.cpp.

                                           {
    if ((brainPin == Gpio::Unassigned) || (brainPin == Gpio::Invalid))
        return false;
 
    if (brainPin > BRAIN_PIN_LAST)
        /* something terribly wrong */
        return false;
 
    return true;
}

Referenced by applyIACposition(), boardGetAnalogDiagnostic(), cdmIonInit(), NitrousController::checkTriggerPinState(), FrequencySensor::deInit(), HellaOilLevelSensor::deInit(), OutputPin::deInit(), deInitFlexSensor(), directWritePad(), efiExtiDisablePin(), efiExtiEnablePin(), efiReadPin(), efiSetPadMode(), getAdcChannelForTrigger(), getBrakePedalState(), getClutchDownState(), getClutchUpState(), getHwPin(), getHwPort(), TriggerCentral::handleShaftSignal(), handleVvtCamSignal(), hasAcToggle(), TachometerModule::init(), GenericGearController::init(), HellaOilLevelSensor::init(), BitbangI2c::init(), initAccelerometer(), initAlternatorCtrl(), initAuxValves(), initBoostCtrl(), initDac(), initGpPwm(), StepDirectionStepper::initialize(), FrequencySensor::initIfValid(), OutputPin::initPin(), initPotentiometers(), initSmartGpio(), initSpeedometer(), initVrThresholdPwm(), initWave(), isBoostControlSolenoidMode(), isGpsEnabled(), isIgnVoltage(), AntilagSystemBase::isInsideALSSwitchCondition(), LaunchControlBase::isInsideSwitchCondition(), isMilEnabled(), isSdCardEnabled(), lua_getAuxDigital(), lua_readpin(), onConfigurationChangeTriggerCallback(), onEcuStartDoSomethingTriggerInputPins(), AlternatorController::onFastCallback(), HarleyAcr::onSlowCallback(), SensorChecker::onSlowCallback(), printOutPin(), recalculateAuxValveTiming(), OutputPin::setValue(), startBoostPin(), startCanPins(), startSent(), startSerialChannels(), startTriggerEmulatorPins(), ButtonDebounce::stopConfiguration(), stopLogicAnalyzerPins(), stopSent(), triggerInfo(), turnOnTriggerInputPin(), turnVvtPidOn(), GenericGearController::update(), ShiftTorqueReductionController::updateTriggerPinState(), updateVrThresholdPwm(), validateConfigOnStartUpOrBurn(), and validateTriggerInputs().

pinDiag2string()

void pinDiag2string	(	char *	buffer,
		size_t	size,
		brain_pin_diag_e	pin_diag
	)

Definition at line 115 of file pin_repository.cpp.

                                                                          {
    /* use autogeneraged helpers here? */
    if (pin_diag == PIN_OK) {
        chsnprintf(buffer, size, "Ok");
    } else if (pin_diag != PIN_UNKNOWN) {
        chsnprintf(buffer, size, "%s%s%s%s%s%s",
            pin_diag & PIN_DRIVER_OFF ? "driver_off " : "",
            pin_diag & PIN_OPEN ? "open_load " : "",
            pin_diag & PIN_SHORT_TO_GND ? "short_to_gnd " : "",
            pin_diag & PIN_SHORT_TO_BAT ? "short_to_bat " : "",
            pin_diag & PIN_OVERLOAD ? "overload " : "",
            pin_diag & PIN_DRIVER_OVERTEMP ? "overtemp": "");
    } else {
        chsnprintf(buffer, size, "INVALID");
    }
}

Referenced by benchOff(), SensorChecker::onSlowCallback(), and reportPins().

Here is the caller graph for this function:

Go to the source code of this file.