Blame view

RIOT/sys/include/rtt_stdio.h 1.78 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
  /*
   * Copyright (C) 2016 Michael Andersen <m.andersen@berkeley.edu>
   *
   * 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_rtt_stdio SEGGER RTT stdio
   * @ingroup     sys
   *
   * @brief       stdio init/read/write functions for SEGGER RTT. This is
   *              designed to shadow the functions in uart_stdio
   *
   * @{
   * @file
   *
   * @author      Michael Andersen <m.andersen@cs.berkeley.edu>
   */
  #ifndef RTT_STDIO_H
  #define RTT_STDIO_H
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief initialize the module. This is a noop.
   */
  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 enable stdin polling, at a power consumption cost. This is enabled
   *        by default unless RTT_STDIO_DISABLE_STDIN is defined.
   */
  void rtt_stdio_enable_stdin(void);
  
  /**
   * @brief enable stdout blocking and free space polling. This must be done
   *        with caution because if there is no RTT client attached, all
   *        writes to stdout will block indefinitely. This can be enabled
   *        automatically by defining RTT_STDIO_ENABLE_BLOCKING_STDOUT
   */
  void rtt_stdio_enable_blocking_stdout(void);
  
  #ifdef __cplusplus
  }
  #endif
  /** @} */
  #endif /* RTT_STDIO_H */