foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
io.c File Reference

Driver for the IO module. More...

#include "io.h"
Include dependency graph for io.c:

Go to the source code of this file.

Functions

void IO_SetPinDirectionToOutput (volatile uint32_t *pRegisterAddress, uint32_t pin)
 Set pin to output by writing in pin direction register. More...
 
void IO_SetPinDirectionToInput (volatile uint32_t *pRegisterAddress, uint32_t pin)
 Set pin to input by writing in pin direction register. More...
 
void IO_PinSet (volatile uint32_t *pRegisterAddress, uint32_t pin)
 Set pin by writing in pin output register. More...
 
void IO_PinReset (volatile uint32_t *pRegisterAddress, uint32_t pin)
 Reset pin by writing in pin output register. More...
 
uint8_t IO_PinGet (const volatile uint32_t *pRegisterAddress, uint32_t pin)
 Get pin state. More...
 

Detailed Description

Driver for the IO module.

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2020-06-05 (date of creation)
Updated
2021-07-14 (date of last update)
Prefix
IO

Definition in file io.c.

Function Documentation

◆ IO_PinGet()

uint8_t IO_PinGet ( const volatile uint32_t *  pRegisterAddress,
uint32_t  pin 
)

Get pin state.

The TMS570LC43 has only few dedicated GPIO register. Most of the time the IOs are controlled by a dedicated register in the corresponding peripheral.

Parameters
pRegisterAddressaddress of pin output register
pinbit position corresponding to pin in register
Returns
state of the pin

Definition at line 98 of file io.c.

◆ IO_PinReset()

void IO_PinReset ( volatile uint32_t *  pRegisterAddress,
uint32_t  pin 
)

Reset pin by writing in pin output register.

The TMS570LC43 has only few dedicated GPIO register. Most of the time the IOs are controlled by a dedicated register in the corresponding peripheral.

Parameters
pRegisterAddressaddress of pin output register
pinbit position corresponding to pin in register

Definition at line 91 of file io.c.

◆ IO_PinSet()

void IO_PinSet ( volatile uint32_t *  pRegisterAddress,
uint32_t  pin 
)

Set pin by writing in pin output register.

The TMS570LC43 has only few dedicated GPIO register. Most of the time the IOs are controlled by a dedicated register in the corresponding peripheral.

Parameters
pRegisterAddressaddress of pin output register
pinbit position corresponding to pin in register

Definition at line 84 of file io.c.

◆ IO_SetPinDirectionToInput()

void IO_SetPinDirectionToInput ( volatile uint32_t *  pRegisterAddress,
uint32_t  pin 
)

Set pin to input by writing in pin direction register.

The TMS570LC43 has only few dedicated GPIO register. Most of the time the IOs are controlled by a dedicated register in the corresponding peripheral.

Parameters
pRegisterAddressaddress of pin direction register
pinbit position corresponding to pin in register

Definition at line 77 of file io.c.

◆ IO_SetPinDirectionToOutput()

void IO_SetPinDirectionToOutput ( volatile uint32_t *  pRegisterAddress,
uint32_t  pin 
)

Set pin to output by writing in pin direction register.

The TMS570LC43 has only few dedicated GPIO register. Most of the time the IOs are controlled by a dedicated register in the corresponding peripheral.

Parameters
pRegisterAddressaddress of pin direction register
pinbit position corresponding to pin in register

Definition at line 70 of file io.c.