rusefi-1/firmware/hw_layer/pin_repository.h

69 lines
1.8 KiB
C
Raw Normal View History

2015-07-10 06:01:56 -07:00
/**
* @file pin_repository.h
* @brief I/O pin registry header
*
*
*
* @date Jan 15, 2013
2020-01-13 18:57:43 -08:00
* @author Andrey Belomutskiy, (c) 2012-2020
2015-07-10 06:01:56 -07:00
*/
2020-04-01 16:00:56 -07:00
#pragma once
2015-07-10 06:01:56 -07:00
2018-11-03 10:17:58 -07:00
#include "global.h"
2015-07-10 06:01:56 -07:00
#include "io_pins.h"
#ifdef __cplusplus
2019-03-29 06:11:13 -07:00
#include "efi_gpio.h"
2016-04-03 08:02:57 -07:00
class PinRepository {
public:
/**
* Class constructors are a great way to have simple initialization sequence
*/
2016-04-03 08:02:57 -07:00
PinRepository();
int totalPinsUsed = 0;
2021-07-14 23:00:48 -07:00
const char *PIN_USED[BRAIN_PIN_TOTAL_PINS];
2016-04-03 08:02:57 -07:00
};
2015-07-10 06:01:56 -07:00
#endif /* __cplusplus */
bool isBrainPinValid(brain_pin_e brainPin);
2015-07-10 06:01:56 -07:00
void initPinRepository(void);
EXTERNC bool brain_pin_is_onchip(brain_pin_e brainPin);
EXTERNC bool brain_pin_is_ext(brain_pin_e brainPin);
2022-01-03 11:21:54 -08:00
void pinDiag2string(char *buffer, size_t size, brain_pin_diag_e pin_diag);
2020-02-12 05:34:26 -08:00
2019-05-10 14:53:17 -07:00
/**
2019-05-10 15:51:48 -07:00
* Usually high-level code would invoke efiSetPadMode, not this method directly
2019-05-10 14:53:17 -07:00
*/
EXTERNC bool brain_pin_markUsed(brain_pin_e brainPin, const char *msg);
2019-05-10 14:53:17 -07:00
/**
* See also efiSetPadUnused
*/
EXTERNC void brain_pin_markUnused(brain_pin_e brainPin);
2015-07-10 06:01:56 -07:00
const char * getPinFunction(brain_input_pin_e brainPin);
2019-04-12 14:39:49 -07:00
#if EFI_PROD_CODE
/* For on-chip gpios only */
EXTERNC bool gpio_pin_markUsed(ioportid_t port, ioportmask_t pin, const char *msg);
EXTERNC void gpio_pin_markUnused(ioportid_t port, ioportmask_t pin);
2019-04-12 14:39:49 -07:00
#endif /* EFI_PROD_CODE*/
2015-07-10 06:01:56 -07:00
/* defined in ports/ */
int getPortPinIndex(ioportid_t port, ioportmask_t pin);
ioportid_t getBrainPinPort(brain_pin_e brainPin);
int getBrainPinIndex(brain_pin_e brainPin);
int brainPin_to_index(brain_pin_e brainPin);
unsigned int getBrainPinOnchipNum(void);
unsigned int getBrainPinTotalNum(void);
const char *hwPortname(brain_pin_e brainPin);
2022-05-30 14:06:56 -07:00
// the main usage for human-readable board-specific pin reference is convenience of error messages in case of pin conflict.
const char * getBoardSpecificPinName(brain_pin_e brainPin);
#ifdef __cplusplus
const char* & getBrainUsedPin(unsigned int idx);
#endif