switchbox.h

Go to the documentation of this file.

/*
Copyright (c) 2023 Eindhoven University of Technology
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
#ifndef SWITCHBOX_H
#define SWITCHBOX_H
#include <pinmap.h>
#include <stdbool.h>
#include <stdint.h>
 
typedef enum io_configuration {
  SWB_GPIO = 0x00,
  SWB_Interrupt_In = 0x01,
  SWB_UART0_TX = 0x02,
  SWB_UART0_RX = 0x03,
  SWB_SPI0_CLK = 0x04,
  SWB_SPI0_MISO = 0x05,
  SWB_SPI0_MOSI = 0x06,
  SWB_SPI0_SS = 0x07,
  SWB_SPI1_CLK = 0x08,
  SWB_SPI1_MISO = 0x09,
  SWB_SPI1_MOSI = 0x0A,
  SWB_SPI1_SS = 0x0B,
  SWB_IIC0_SDA = 0x0C,
  SWB_IIC0_SCL = 0x0D,
  SWB_IIC1_SDA = 0x0E,
  SWB_IIC1_SCL = 0x0F,
  SWB_PWM0 = 0x10,
  SWB_PWM1 = 0x11,
  SWB_PWM2 = 0x12,
  SWB_PWM3 = 0x13,
  SWB_PWM4 = 0x14,
  SWB_PWM5 = 0x15,
  SWB_TIMER_G0 = 0x18,
  SWB_TIMER_G1 = 0x19,
  SWB_TIMER_G2 = 0x1A,
  SWB_TIMER_G3 = 0x1B,
  SWB_TIMER_G4 = 0x1C,
  SWB_TIMER_G5 = 0x1D,
  SWB_TIMER_G6 = 0x1E,
  SWB_TIMER_G7 = 0x1F,
  SWB_UART1_TX = 0x22,
  SWB_UART1_RX = 0x23,
  SWB_TIMER_IC0 = 0x38,
  SWB_TIMER_IC1 = 0x39,
  SWB_TIMER_IC2 = 0x3A,
  SWB_TIMER_IC3 = 0x3B,
  SWB_TIMER_IC4 = 0x3C,
  SWB_TIMER_IC5 = 0x3D,
  SWB_TIMER_IC6 = 0x3E,
  SWB_TIMER_IC7 = 0x3F,
  NUM_IO_CONFIGURATIONS,
} io_configuration_t;
 
#define NUM_SWITCHBOX_NAMES 40
extern char *const switchbox_names[NUM_SWITCHBOX_NAMES];
 
extern void switchbox_init(void);
 
extern void switchbox_set_pin(const io_t pin_number,
                              const io_configuration_t pin_type);
 
extern void switchbox_reset(void);
 
extern void switchbox_destroy(void);
 
extern io_configuration_t switchbox_get_pin(const io_t pin_number);
 
#endif // SWITCHBOX_H