elbear_arduino_bsp/variants/start/variant.c

/**
 *******************************************************************************
 * Copyright (c) 2021 Nanjing Qinheng Microelectronics Co., Ltd.
 * All rights reserved.
 *
 * This software component is licensed by WCH under BSD 3-Clause license,
 * the "License"; You may not use this file except in compliance with the
 * License. You may obtain a copy of the License at:
 *                        opensource.org/licenses/BSD-3-Clause
 *
 *******************************************************************************
 */

#include "pins_arduino.h"
#include "mik32_hal_adc.h"
#include "wiring_analog.h"
#include "wiring_LL.h"

/**
 * @brief Determines the address of the port by the board pin number to which this pin belongs on the MCU
 * @return The address of the port corresponding to the board pin number. Can return 0 if the pin not exists
 */

GPIO_TypeDef *digitalPinToPort(uint32_t digitalPinNumber)
{
  if (digitalPinNumber < 16u)
  {
    return GPIO_0;
  }
  else if ((digitalPinNumber >= 16u) && (digitalPinNumber < 32u))
  {
    return GPIO_1;
  }
  else if ((digitalPinNumber >= 32u) && (digitalPinNumber < 40u))
  {
    return GPIO_2;
  }
  else
  {
    return NULL;
  }
}

// determines the pin address inside the port by the board pin number
HAL_PinsTypeDef digitalPinToBitMask(uint32_t digitalPinNumber)
{
  return 1 << (digitalPinNumber & 0xF);
}

uint16_t pinCommonQty(void)
{
  return (uint16_t)40;
}

// the function returns a reference to the OUTPUT address of the GPIO register
volatile uint32_t *portOutputRegister(GPIO_TypeDef *GPIO_x)
{
  return &GPIO_x->OUTPUT_;
}

// the function returns a reference to the STATE address of the GPIO register
volatile uint32_t *portInputRegister(GPIO_TypeDef *GPIO_x)
{
  return &GPIO_x->STATE;
}

// ---------------------- ADC ---------------------- //
// determines the ADC channel number by the board pin number
uint32_t analogInputToChannelNumber(uint32_t PinNumber)
{
  uint32_t adcChannel = 0;

  switch (PinNumber)
  {
  case PIN_A0:
    adcChannel = ADC_CHANNEL0;
    break;
  case PIN_A1:
    adcChannel = ADC_CHANNEL1;
    break;
  case PIN_A2:
    adcChannel = ADC_CHANNEL2;
    break;
  case PIN_A3:
    adcChannel = ADC_CHANNEL3;
    break;
  case PIN_A4:
    adcChannel = ADC_CHANNEL4;
    break;
  case PIN_A5:
    adcChannel = ADC_CHANNEL5;
    break;
  case PIN_A6:
    adcChannel = ADC_CHANNEL6;
    break;
  case PIN_A7:
    adcChannel = ADC_CHANNEL7;
    break;
  default:
    adcChannel = NC;
  }
  return adcChannel;
}

// ---------------------- PWM ---------------------- //
// use only if digitalPinHasPWM() == true
#define PWM_PIN_TO_PORT_NUMBER(pin) (((pin) & 16) ? 1 : 0)
// use only if digitalPinHasPWM() == true
static inline uint8_t pwmPinToGpioPinShift(uint8_t digitalPin)
{
  return digitalPin & 3;
}
// use only if digitalPinHasPWM() == true
// return true if digitalPin configured as pwm
bool digitalPinPwmIsOn(uint8_t digitalPin)
{
  uint8_t config = 0;
  uint8_t pinShift = pwmPinToGpioPinShift(digitalPin);

  if (PWM_PIN_TO_PORT_NUMBER(digitalPin) == 0)
    config = PIN_GET_PAD_CONFIG(PORT_0_CFG, pinShift);
  else
    config = PIN_GET_PAD_CONFIG(PORT_1_CFG, pinShift);

  if (config == 2)
    return true;
  else
    return false;
}

bool digitalPinHasPWM(uint8_t p)
{
  return (p < 32) && ((p & 0xF) < 4);
}

// function is used only if digitalPinHasPWM() is true
TIMER32_TypeDef *pwmPinToTimer(uint32_t digPinNumber)
{
  if (digPinNumber < 16)
  {
    return TIMER32_1;
  }
  else if ((digPinNumber >= 16) && (digPinNumber < 32))
  {
    return TIMER32_2;
  }
  else
  {
    return NULL;
  }
}

// function is used only if digitalPinHasPWM() is true
HAL_TIMER32_CHANNEL_IndexTypeDef pwmPinToTimerChannel(uint32_t digPinNumber)
{
  switch (digPinNumber & 0x3)
  {
  case 0:
    return TIMER32_CHANNEL_0;
  case 1:
    return TIMER32_CHANNEL_1;
  case 2:
    return TIMER32_CHANNEL_2;
  case 3:
    return TIMER32_CHANNEL_3;
  }
}

// ---------------------- interrupts ---------------------- //
// interrupt table is stored in ram to improve performance
// index = interrupt number. In each row {digitalPinNumber, IntLineValue, IntMuxValue}
uint8_t interruptInfo[EXTERNAL_NUM_INTERRUPTS][3] =
    {
        {2, GPIO_LINE_2, GPIO_MUX_LINE_2_PORT0_10},          // INT0
        {3, GPIO_LINE_0, GPIO_MUX_LINE_0_PORT0_0},           // INT1
        {4, GPIO_LINE_4, GPIO_MUX_LINE_4_PORT0_8},           // INT2
        {5, GPIO_LINE_1, GPIO_MUX_LINE_1_PORT0_1},           // INT3
        {8, GPIO_LINE_5, GPIO_MUX_LINE_5_PORT1_9},           // INT4
        {9, GPIO_LINE_3, GPIO_MUX_LINE_3_PORT0_3},           // INT5
        {BTN_BUILTIN, GPIO_LINE_6, GPIO_MUX_LINE_6_PORT2_6}, // INT6 (button)
};

int8_t digitalPinToGpioIntMux(uint8_t digPinNumber)
{
  for (uint8_t i = 0; i < EXTERNAL_NUM_INTERRUPTS; i++)
  {
    if (interruptInfo[i][0] == digPinNumber)
      return interruptInfo[i][2];
  }
  return NOT_AN_INTERRUPT;
}
int8_t digitalPinToGpioIntLine(uint8_t digPinNumber)
{
  for (uint8_t i = 0; i < EXTERNAL_NUM_INTERRUPTS; i++)
  {
    if (interruptInfo[i][0] == digPinNumber)
      return interruptInfo[i][1];
  }
  return NOT_AN_INTERRUPT;
}

int8_t gpioIntLineToInterrupt(uint32_t gpioIntLine)
{
  for (uint8_t i = 0; i < EXTERNAL_NUM_INTERRUPTS; i++)
  {
    if (interruptInfo[i][1] == gpioIntLine)
      return i;
  }
  return NOT_AN_INTERRUPT;
}

int8_t digitalPinToInterrupt(uint32_t digPinNumber)
{
  for (uint8_t i = 0; i < EXTERNAL_NUM_INTERRUPTS; i++)
  {
    if (interruptInfo[i][0] == digPinNumber)
      return i;
  }
  return NOT_AN_INTERRUPT;
}

// ---------------------- SPI ---------------------- //
void spi_onBegin(void)
{
  return;
}

void spi_onEnd(void)
{
  return;
}