neorv32/sw/lib/source/neorv32_gpio.c

172 lines
6.9 KiB
C
Raw Permalink Normal View History

2024-02-24 08:25:27 +00:00
// #################################################################################################
// # << NEORV32: neorv32_gpio.c - General Purpose Input/Output Port HW Driver (Source) >> #
// # ********************************************************************************************* #
// # BSD 3-Clause License #
// # #
// # Copyright (c) 2022, Stephan Nolting. All rights reserved. #
// # #
// # 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. #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
// #################################################################################################
/**********************************************************************//**
* @file neorv32_gpio.c
* @brief General purpose input/output port unit (GPIO) HW driver source file.
*
* @note These functions should only be used if the GPIO unit was synthesized (IO_GPIO_EN = true).
**************************************************************************/
#include "neorv32.h"
#include "neorv32_gpio.h"
/**********************************************************************//**
* Check if GPIO unit was synthesized.
*
* @return 0 if GPIO was not synthesized, 1 if GPIO is available.
**************************************************************************/
int neorv32_gpio_available(void) {
if (NEORV32_SYSINFO->SOC & (1 << SYSINFO_SOC_IO_GPIO)) {
return 1;
}
else {
return 0;
}
}
/**********************************************************************//**
* Set single pin of GPIO's output port.
*
* @param[in] pin Output pin number to be set (0..63).
**************************************************************************/
void neorv32_gpio_pin_set(int pin) {
uint32_t mask = (uint32_t)(1 << (pin & 0x1f));
if (pin < 32) {
NEORV32_GPIO->OUTPUT_LO |= mask;
}
else {
NEORV32_GPIO->OUTPUT_HI |= mask;
}
}
/**********************************************************************//**
* Clear single pin of GPIO's output port.
*
* @param[in] pin Output pin number to be cleared (0..63).
**************************************************************************/
void neorv32_gpio_pin_clr(int pin) {
uint32_t mask = (uint32_t)(1 << (pin & 0x1f));
if (pin < 32) {
NEORV32_GPIO->OUTPUT_LO &= ~mask;
}
else {
NEORV32_GPIO->OUTPUT_HI &= ~mask;
}
}
/**********************************************************************//**
* Toggle single pin of GPIO's output port.
*
* @param[in] pin Output pin number to be toggled (0..63).
**************************************************************************/
void neorv32_gpio_pin_toggle(int pin) {
uint32_t mask = (uint32_t)(1 << (pin & 0x1f));
if (pin < 32) {
NEORV32_GPIO->OUTPUT_LO ^= mask;
}
else {
NEORV32_GPIO->OUTPUT_HI ^= mask;
}
}
/**********************************************************************//**
* Get single pin of GPIO's input port.
*
* @param[in] pin Input pin to be read (0..63).
* @return =0 if pin is low, !=0 if pin is high.
**************************************************************************/
uint32_t neorv32_gpio_pin_get(int pin) {
uint32_t mask = (uint32_t)(1 << (pin & 0x1f));
if (pin < 32) {
return NEORV32_GPIO->INPUT_LO & mask;
}
else {
return NEORV32_GPIO->INPUT_HI & mask;
}
}
/**********************************************************************//**
* Set complete GPIO output port.
*
* @param[in] port_data New output port value (64-bit).
**************************************************************************/
void neorv32_gpio_port_set(uint64_t port_data) {
union {
uint64_t uint64;
uint32_t uint32[sizeof(uint64_t)/sizeof(uint32_t)];
} data;
data.uint64 = port_data;
NEORV32_GPIO->OUTPUT_LO = data.uint32[0];
NEORV32_GPIO->OUTPUT_HI = data.uint32[1];
}
/**********************************************************************//**
* Get complete GPIO input port.
*
* @return Current input port state (64-bit).
**************************************************************************/
uint64_t neorv32_gpio_port_get(void) {
union {
uint64_t uint64;
uint32_t uint32[sizeof(uint64_t)/sizeof(uint32_t)];
} data;
data.uint32[0] = NEORV32_GPIO->INPUT_LO;
data.uint32[1] = NEORV32_GPIO->INPUT_HI;
return data.uint64;
}