aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gdisp/ED060SC4/board_ED060SC4_template.h
blob: 6d71a9865a62ed9600e8caa0cc60433ed01cf2ed (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/*
 * This file is subject to the terms of the GFX License. If a copy of
 * the license was not distributed with this file, you can obtain one at:
 *
 *              http://ugfx.org/license.html
 */

/**
 * @file    drivers/gdisp/ST7565/board_ST7565_template.h
 * @brief   GDISP Graphic Driver subsystem board interface for the ST7565 display.
 *
 * @addtogroup GDISP
 * @{
 */

#ifndef _GDISP_LLD_BOARD_H
#define _GDISP_LLD_BOARD_H

/**
 * @brief	Optional parameters that can be put in this file.
 * @note	The values listed below are the defaults.
 *
 * @note	#define GDISP_SCREEN_HEIGHT		600
 * @note	#define GDISP_SCREEN_WIDTH		800
 *
 * @note	Number of pixels per byte<br>
 * 			#define EINK_PPB				4
 *
 * @note	Delay for generating clock pulses.
 *			Unit is approximate clock cycles of the CPU (0 to 15).
 *			This should be atleast 50 ns.<br>
 *			#define EINK_CLOCKDELAY			0
 *
 * @note	Width of one framebuffer block.
 *			Must be divisible by EINK_PPB and evenly divide GDISP_SCREEN_WIDTH.<br>
 *			#define EINK_BLOCKWIDTH			20
 *
 * @note
 * @note	Height of one framebuffer block.
 *			Must evenly divide GDISP_SCREEN_WIDTH.<br>
 *			#define EINK_BLOCKHEIGHT		20
 *
 * @note	Number of block buffers to use for framebuffer emulation.<br>
 * 			#define EINK_NUMBUFFERS			40
 *
 * @note	Do a "blinking" clear, i.e. clear to opposite polarity first.
 *			This reduces the image persistence.<br>
 *			#define EINK_BLINKCLEAR			TRUE
 *
 * @note	Number of passes to use when clearing the display<br>
 *			#define EINK_CLEARCOUNT			10
 *
 * @note	Number of passes to use when writing to the display<br>
 *			#define EINK_WRITECOUNT			4
 */

/**
 * @brief   Initialise the board for the display.
 *
 * @param[in] g			The GDisplay structure
 *
 * @note	Set the g->board member to whatever is appropriate. For multiple
 * 			displays this might be a pointer to the appropriate register set.
 *
 * @notapi
 */
static inline void init_board(GDisplay *g) {
	(void) g;
}

/**
 * @brief	Delay for display waveforms. Should be an accurate microsecond delay.
 *
 * @param[in] us		The number of microseconds
 */
static void eink_delay(int us) {
	(void) us;
}

/**
 * @brief	Turn the E-ink panel Vdd supply (+3.3V) on or off.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpower_vdd(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Turn the E-ink panel negative supplies (-15V, -20V) on or off.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpower_vneg(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Turn the E-ink panel positive supplies (-15V, -20V) on or off.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpower_vpos(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Set the state of the LE (source driver Latch Enable) pin.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpin_le(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Set the state of the OE (source driver Output Enable) pin.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpin_oe(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Set the state of the CL (source driver Clock) pin.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpin_cl(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Set the state of the SPH (source driver Start Pulse Horizontal) pin.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpin_sph(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Set the state of the D0-D7 (source driver Data) pins.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] value		The byte to write
 */
static inline void setpins_data(GDisplay *g, uint8_t value) {
	(void) g;
	(void) value;
}

/**
 * @brief	Set the state of the CKV (gate driver Clock Vertical) pin.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpin_ckv(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Set the state of the GMODE (gate driver Gate Mode) pin.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpin_gmode(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

/**
 * @brief	Set the state of the SPV (gate driver Start Pulse Vertical) pin.
 *
 * @param[in] g			The GDisplay structure
 * @param[in] on		On or off
 */
static inline void setpin_spv(GDisplay *g, bool_t on) {
	(void) g;
	(void) on;
}

#endif /* _GDISP_LLD_BOARD_H */
/** @} */