This module contains the implementation for the digital input/output peripheral configuration. More...

#include "dio_cfg.h"

Include dependency graph for dio_cfg.c:

Functions
const DioConfig_t *const	DIO_configGet (void)

size_t	DIO_configSizeGet (void)

Variables
const DioConfig_t	DioConfig []

Detailed Description

This module contains the implementation for the digital input/output peripheral configuration.

Author: Jose Luis Figueroa

Version: 1.1

Date: 2025-03-04

Copyright: Copyright (c) 2023 Jose Luis Figueroa. MIT License.

Function Documentation

◆ DIO_configGet()

const DioConfig_t *const DIO_configGet ( void )

Description: This function is used to initialize the DIO based on the configuration table defined in dio_cfg module.

PRE-CONDITION: configuration table needs to be populated (sizeof > 0)

POST-CONDITION: A constant pointer to the first member of the
configuration table will be returned.

Returns: A pointer to the configuration table.

Example:

const Dio_Config_t * const DioConfig = DIO_configGet();
size_t configSize = DIO_configSizeGet();
 
DIO_Init(DioConfig, configSize);

See also: DIO_configGet; DIO_configSizeGet; DIO_init; DIO_channelRead; DIO_channelWrite; DIO_channelToggle; DIO_registerWrite; DIO_registerRead

◆ DIO_configSizeGet()

size_t DIO_configSizeGet ( void )

Description: This function is used to get the size of the configuration table.

PRE-CONDITION: configuration table needs to be populated (sizeof > 0)

POST-CONDITION: The size of the configuration table will be returned.

Returns: The size of the configuration table.

Example:

const Dio_Config_t * const DioConfig = DIO_configGet();
size_t configSize = DIO_configSizeGet();
 
DIO_Init(DioConfig, configSize);

See also: DIO_configGet; DIO_configSizeGet; DIO_init; DIO_channelRead; DIO_channelWrite; DIO_channelToggle; DIO_registerWrite; DIO_registerRead

Variable Documentation

◆ DioConfig

const DioConfig_t DioConfig[]

Initial value:

= 
{
 
   {DIO_PA, DIO_PA0, DIO_OUTPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
   {DIO_PA, DIO_PA1, DIO_OUTPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
   {DIO_PA, DIO_PA2, DIO_OUTPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
   {DIO_PA, DIO_PA3, DIO_OUTPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
   {DIO_PA, DIO_PA4, DIO_OUTPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
   {DIO_PA, DIO_PA5, DIO_OUTPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
   {DIO_PB, DIO_PB0, DIO_OUTPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
   {DIO_PC, DIO_PC13, DIO_INPUT, DIO_PUSH_PULL, DIO_LOW_SPEED, DIO_NO_RESISTOR, DIO_AF0},
}

The following array contains the configuration data for each digital input/output peripheral channel (pin). Each row represent a single pin. Each column is representing a member of the DioConfig_t structure. This table is read in by Dio_Init, where each channel is then set up based on this table. The NUMBER_DIGITAL_PINS constant should be accorded with the number of rows.

Functions