140 lines
3.5 KiB
C
140 lines
3.5 KiB
C
/* uart_i.h */
|
|
/*
|
|
This file is part of the AVR-uart_ni.
|
|
Copyright (C) 2009 Daniel Otte (daniel.otte@rub.de)
|
|
|
|
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/>.
|
|
*/
|
|
/**
|
|
* \file uart_i.h
|
|
* \email daniel.otte@rub.de
|
|
* \author Daniel Otte
|
|
* \date 2009-07-24
|
|
* \license GPLv3 or later
|
|
* \ingroup uart_i
|
|
* \brief declaration for non-interrupt uart
|
|
*/
|
|
|
|
#ifndef UART_I_H_
|
|
#define UART_I_H_
|
|
|
|
#include "config.h"
|
|
#include "circularbytebuffer.h"
|
|
#include <stdint.h>
|
|
|
|
typedef struct{
|
|
circularbytebuffer_t rxb;
|
|
circularbytebuffer_t txb;
|
|
#if UART0_HOOK
|
|
void(*hook)(uint8_t);
|
|
volatile uint8_t hook_running;
|
|
#endif
|
|
#if UART0_SWFLOWCTRL
|
|
volatile uint8_t txon;
|
|
volatile uint8_t rxon;
|
|
#endif
|
|
} uart0_ctx_t;
|
|
|
|
|
|
typedef struct{
|
|
circularbytebuffer_t rxb;
|
|
circularbytebuffer_t txb;
|
|
#if UART1_HOOK
|
|
void(*hook)(uint8_t);
|
|
volatile uint8_t hook_running;
|
|
#endif
|
|
#if UART1_SWFLOWCTRL
|
|
volatile uint8_t txon;
|
|
volatile uint8_t rxon;
|
|
#endif
|
|
} uart1_ctx_t;
|
|
|
|
#if UART0_I
|
|
|
|
/** \fn uart0_init(void)
|
|
* \brief initialize uart0.
|
|
* This function initializes the first uart according to the parameter specifyed
|
|
* in config.h .
|
|
*/
|
|
void uart0_init(void);
|
|
|
|
/** \fn uart0_putc(uint16_t)
|
|
* \brief send data through uart0.
|
|
* This function sends data through the first uart
|
|
* (the data size is debfined in config.h).
|
|
* \param c data to send
|
|
*/
|
|
void uart0_putc(uint16_t c);
|
|
|
|
/** \fn uart0_getc(void)
|
|
* \brief read data from uart0.
|
|
* This function reads data from the first uart
|
|
* (the data size is debfined in config.h).
|
|
* \return data recived by uart0
|
|
*/
|
|
uint16_t uart0_getc(void);
|
|
|
|
/** \fn uart0_dataavail(void)
|
|
* \brief checks if data is available.
|
|
*
|
|
* This function checks the state of the input buffer of uart0 and
|
|
* returns if data is available or not.
|
|
* \return zero if no data is available else a value different from zero is returned
|
|
*/
|
|
uint8_t uart0_dataavail(void);
|
|
|
|
#if UART0_HOOK
|
|
void uart0_sethook(void(*fpt)(uint8_t));
|
|
#endif
|
|
|
|
|
|
#endif /* UART0_I */
|
|
|
|
#if UART1_I
|
|
/** \fn uart1_init(void)
|
|
* \brief initialize uart1.
|
|
* This function initializes the second uart according to the parameter specifyed
|
|
* in config.h .
|
|
*/
|
|
void uart1_init(void);
|
|
|
|
/** \fn uart1_putc(uint16_t)
|
|
* \brief send data through uart1.
|
|
* This function sends data through the second uart
|
|
* (the data size is debfined in config.h).
|
|
* \param c data to send
|
|
*/
|
|
void uart1_putc(uint16_t c);
|
|
|
|
/** \fn uart1_getc(void)
|
|
* \brief read data from uart1.
|
|
* This function reads data from the second uart
|
|
* (the data size is debfined in config.h).
|
|
* \return data recived by uart1
|
|
*/
|
|
uint16_t uart1_getc(void);
|
|
|
|
/** \fn uart1_dataavail(void)
|
|
* \brief checks if data is available.
|
|
* This function checks the state of the input buffer of uart1 and
|
|
* returns if data is available or not.
|
|
* \return zero if no data is available else a value different from zero is returned
|
|
*/
|
|
uint8_t uart1_dataavail(void);
|
|
|
|
void uart0_sethook(void(*fpt)(uint8_t));
|
|
#endif
|
|
|
|
#endif /* UART_I_H_ */
|