aboutsummaryrefslogtreecommitdiffstats
path: root/firmware/microblaze/lib/hal_uart.h
blob: dfd73c3238c4bb8284d3917140137125222840fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/* -*- c -*- */
/*
 * Copyright 2007,2008 Free Software Foundation, Inc.
 *
 * 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 INCLUDED_HAL_UART_H
#define INCLUDED_HAL_UART_H

/*!
 * \brief uart mode flags
 */
#define	UART_MODE_RAW		0x0000	// no mapping on input or output
#define	UART_MODE_ONLCR	0x0001	// map \n to \r\n on output (default)

/*
 * \brief Set uart mode
 */
void hal_uart_set_mode(int flags);

/*!
 * \brief one-time call to init
 */
void hal_uart_init(void);

typedef enum {
  US_9600,
  US_19200,
  US_38400,
  US_57600,
  US_115200,
  US_230400,
} hal_uart_speed_t;

typedef struct {
  hal_uart_speed_t	speed;
} hal_uart_config_t;

/*!
 * \brief Set uart parameters
 *  Default is 115,200 bps, 8N1.
 */
void hal_uart_set_config(const hal_uart_config_t *c);

/*!
 * \brief Get uart configuation.
 */
void hal_uart_get_config(hal_uart_config_t *c);

/*!
 * \brief Enqueue \p ch for output over serial port
 */
void hal_uart_putc(int ch);

/*!
 * \brief Enqueue \p ch for output over serial port, silent fail if queue is full
 */
void hal_uart_putc_nowait(int ch);

/*
 * \brief Blocking read of next char from serial port
 */
int hal_uart_getc(void);


#endif /* INCLUDED_HAL_UART_H */