aboutsummaryrefslogtreecommitdiffstats
path: root/console.h
blob: 6f017d885d5cc20d07b1be1232886363aa6a6e6a (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
#ifndef CONSOLE_H
#define CONSOLE_H

/**
 * @brief   Structure representing a GLCD driver.
 */
typedef struct GLCDConsole GLCDConsole;

/**
 * @brief   @p GLCDConsole specific methods.
 */
#define _glcd_driver_methods                                              \
  _base_asynchronous_channel_methods

/**
 * @extends BaseAsynchronousChannelVMT
 *
 * @brief   @p GLCDConsole virtual methods table.
 */
struct GLCDConsoleVMT {
  _glcd_driver_methods
};

/**
 * @extends BaseAsynchronousChannel
 *
 * @brief   GLCD Console class.
 * @details This class extends @p BaseAsynchronousChannel by adding physical
 *          I/O queues.
 */
struct GLCDConsole {
  /** @brief Virtual Methods Table.*/
  const struct GLCDConsoleVMT *vmt;
  _base_asynchronous_channel_data
  /* WARNING: Do not add any data to this struct above this comment, only below */
  /* text buffer */
  uint8_t *buf;
  /* lcd area to use */
  uint16_t x0,y0,x1,y1;
  /* current cursor position, in character coordinates (not pixels) */
  uint16_t cx,cy;
  /* console size in characters */
  uint16_t sx,sy;
  /* foreground and background colour */
  uint16_t bkcolor, color;
  /* font size in pixels */
  uint8_t fx,fy;
  /* buffer index */
  uint16_t bidx;
};

#ifdef __cplusplus
extern "C" {
#endif

msg_t lcdConsoleInit(GLCDConsole *console, uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1,
		const uint8_t *font, uint8_t *buffer, uint16_t bkcolor, uint16_t color);

#ifdef __cplusplus
}
#endif

#endif /* CONSOLE_H */