gpio.h

#pragma once
 
/************************************************************************************************
 * @file   gpio.h
 *
 * @brief  GPIO Library Header file
 *
 * @date   2024-11-02
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "status.h"
 
#ifndef GPIO_PINS_PER_PORT
#define GPIO_PINS_PER_PORT 16U
#endif
 
#ifndef GPIO_ADDRESS_OFFSET
#define GPIO_ADDRESS_OFFSET 0x400U
#endif
 
typedef enum {
  GPIO_STATE_LOW = 0, 
  GPIO_STATE_HIGH,    
  NUM_GPIO_STATES,    
} GpioState;
 
typedef enum {
  GPIO_ANALOG = 0,        
  GPIO_INPUT_FLOATING,    
  GPIO_INPUT_PULL_DOWN,   
  GPIO_INPUT_PULL_UP,     
  GPIO_OUTPUT_OPEN_DRAIN, 
  GPIO_OUTPUT_PUSH_PULL,  
  GPIO_ALTFN_OPEN_DRAIN,  
  GPIO_ALTFN_PUSH_PULL,   
  NUM_GPIO_MODES,         
} GpioMode;
 
typedef enum {
  // No ALT function
  GPIO_ALT_NONE = 0x00U, 
  // GPIO_ALT0 - System
  GPIO_ALT0_SWDIO = 0x00U, 
  GPIO_ALT0_SWCLK = 0x00U, 
  // GPIO_ALT1 - TIM1/TIM2
  GPIO_ALT1_TIM1 = 0x01U, 
  GPIO_ALT1_TIM2 = 0x01U, 
  // GPIO_ALT4 - I2C
  GPIO_ALT4_I2C1 = 0x04U, 
  GPIO_ALT4_I2C2 = 0x04U, 
  GPIO_ALT4_I2C3 = 0x04U, 
  // GPIO_ALT5 - SPI
  GPIO_ALT5_SPI1 = 0x05U, 
  GPIO_ALT5_SPI2 = 0x05U, 
  // GPIO_ALT6 - SPI3
  GPIO_ALT6_SPI3 = 0x06U, 
  // GPIO_ALT7 - USART
  GPIO_ALT7_USART1 = 0x07U, 
  GPIO_ALT7_USART2 = 0x07U, 
  GPIO_ALT7_USART3 = 0x07U, 
  // GPIO_ALT9 - CAN1
  GPIO_ALT9_CAN1 = 0x09U, 
  // GPIO_ALT14 - Timers
  GPIO_ALT14_TIM15 = 0x0EU, 
  GPIO_ALT14_TIM16 = 0x0EU, 
} GpioAlternateFunctions;
 
typedef enum {
  GPIO_PORT_A = 0, 
  GPIO_PORT_B,     
  GPIO_PORT_C,     
  GPIO_PORT_D,     
  GPIO_PORT_E,     
  GPIO_PORT_H,     
  NUM_GPIO_PORTS,  
} GpioPort;
 
#define GPIO_TOTAL_PINS ((GPIO_PINS_PER_PORT) * (NUM_GPIO_PORTS))
 
typedef struct GpioAddress {
  GpioPort port; 
  uint8_t pin;   
} GpioAddress;
 
StatusCode gpio_init(void);
 
StatusCode gpio_init_pin(const GpioAddress *address, const GpioMode pin_mode, GpioState init_state);
 
StatusCode gpio_init_pin_af(const GpioAddress *address, const GpioMode pin_mode, GpioAlternateFunctions alt_func);
 
StatusCode gpio_set_state(const GpioAddress *address, GpioState state);
 
StatusCode gpio_toggle_state(const GpioAddress *address);
 
GpioState gpio_get_state(const GpioAddress *address);