kopia lustrzana https://github.com/OpenRTX/OpenRTX
85 wiersze
3.2 KiB
C
85 wiersze
3.2 KiB
C
/***************************************************************************
|
|
* Copyright (C) 2021 - 2025 by Federico Amedeo Izzo IU2NUO, *
|
|
* Niccolò Izzo IU2KIN *
|
|
* Frederik Saraci IU2NRO *
|
|
* Silvano Seva IU2KWO *
|
|
* *
|
|
* Adapted from STM32 USART driver for miosix kernel written by Federico *
|
|
* Terraneo. *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 3 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program; if not, see <http://www.gnu.org/licenses/> *
|
|
***************************************************************************/
|
|
|
|
#ifndef USART3_H
|
|
#define USART3_H
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Initialise USART3 peripheral with a given baud rate. Serial communication is
|
|
* configured for 8 data bits, no parity, one stop bit.
|
|
*
|
|
* @param baudrate: serial port baud rate, in bits per second.
|
|
*/
|
|
void usart3_init(unsigned int baudrate);
|
|
|
|
/**
|
|
* Shut down USART3 peripheral.
|
|
*/
|
|
void usart3_terminate();
|
|
|
|
/**
|
|
* Read a block of data.
|
|
*
|
|
* \param buffer buffer where read data will be stored.
|
|
* \param size buffer size.
|
|
* \param where where to read from.
|
|
* \return number of bytes read or a negative number on failure. Note that
|
|
* it is normal for this function to return less character than the amount
|
|
* asked.
|
|
*/
|
|
ssize_t usart3_readBlock(void *buffer, size_t size, off_t where);
|
|
|
|
/**
|
|
* Write a block of data.
|
|
*
|
|
* \param buffer buffer where take data to write.
|
|
* \param size buffer size.
|
|
* \param where where to write to.
|
|
* \return number of bytes written or a negative number on failure.
|
|
*/
|
|
ssize_t usart3_writeBlock(void *buffer, size_t size, off_t where);
|
|
|
|
/**
|
|
* Write a string.
|
|
* Can be used to write debug information before the kernel is started or in
|
|
* case of serious errors, right before rebooting.
|
|
* Can ONLY be called when the kernel is not yet started, paused or within
|
|
* an interrupt. This default implementation ignores writes.
|
|
*
|
|
* \param str the string to write. The string must be NUL terminated.
|
|
*/
|
|
void usart3_IRQwrite(const char *str);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* USART3_H */
|