Blame view

RIOT/sys/include/uart_stdio.h 1.79 KB
a752c7ab   elopes   add first test an...
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
79
80
81
82
83
84
85
86
87
88
89
90
91
  /*
   * Copyright (C) 2015 Kaspar Schleiser <kaspar@schleiser.de>
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    sys_uart_stdio UART stdio
   * @ingroup     sys
   *
   * @brief       stdio init/read/write functions for UARTs
   *
   * @{
   * @file
   *
   * @author      Kaspar Schleiser <kaspar@schleiser.de>
   */
  #ifndef UART_STDIO_H
  #define UART_STDIO_H
  
  /* Boards may override the default STDIO UART device */
  #include <stdint.h>
  #include "board.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  #ifndef UART_STDIO_DEV
  /**
   * @brief UART device to use for STDIO
   */
  #define UART_STDIO_DEV           UART_DEV(0)
  #endif
  
  #ifndef UART_STDIO_BAUDRATE
  /**
   * @brief Baudrate for STDIO
   */
  #define UART_STDIO_BAUDRATE      (115200)
  #endif
  
  #ifndef UART_STDIO_RX_BUFSIZE
  /**
   * @brief Buffer size for STDIO
   */
  #define UART_STDIO_RX_BUFSIZE    (64)
  #endif
  
  /**
   * @brief initialize the module
   */
  void uart_stdio_init(void);
  
  /**
   * @brief read @p len bytes from stdio uart into @p buffer
   *
   * @param[out]  buffer  buffer to read into
   * @param[in]   len     nr of bytes to read
   *
   * @return nr of bytes read
   * @return <0 on error
   */
  int uart_stdio_read(char* buffer, int len);
  
  /**
   * @brief write @p len bytes from @p buffer into uart
   *
   * @param[in]   buffer  buffer to read from
   * @param[in]   len     nr of bytes to write
   *
   * @return nr of bytes written
   * @return <0 on error
   */
  int uart_stdio_write(const char* buffer, int len);
  
  /**
   * @brief internal callback for periph/uart drivers
   *
   * @param[in]   arg     (unused)
   * @param[in]   data    character that has been received
   */
  void uart_stdio_rx_cb(void *arg, uint8_t data);
  
  #ifdef __cplusplus
  }
  #endif
  /** @} */
  #endif /* UART_STDIO_H */