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
203
204
205
206
207
208
209
210
211
212
|
/************************************************************************************
* include/nuttx/input/slcd_codec.h
* Serialize and marshaling data and events for character-based, segment LCDs
*
* Copyright (C) 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
************************************************************************************/
#ifndef __INCLUDE_NUTTX_INPUT_SLCD_CODEC_H
#define __INCLUDE_NUTTX_INPUT_SLCD_CODEC_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <nuttx/streams.h>
#ifdef CONFIG_LIB_SLCDCODEC
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Public Types
****************************************************************************/
/* These are the special SLCD commands recognized by the CODEC. NOTE: that
* some require a a count argument, N.
*/
enum slcdcode_e
{
SLCDCODE_NORMAL = 0, /* Not a special keycode */
/* Delete and Backspace keycodes (in case they may be different than the
* ASCII BKSP and DEL values.
*/
SLCDCODE_FWDDEL, /* DELete (forward delete) N characters moving text */
SLCDCODE_BACKDEL, /* Backspace (backward delete) N characters moving cursor */
SLCDCODE_ERASE, /* Erase N characters from the cursor position */
SLCDCODE_ERASEEOL, /* Erase from the cursor position to the end of line */
SLCDCODE_CLEAR, /* Home the cursor and erase the entire display */
/* Cursor movement */
SLCDCODE_HOME, /* Cursor home */
SLCDCODE_END, /* Cursor end */
SLCDCODE_LEFT, /* Cursor left by N characters */
SLCDCODE_RIGHT, /* Cursor right by N characters */
SLCDCODE_UP, /* Cursor up by N lines */
SLCDCODE_DOWN, /* Cursor down by N lines */
SLCDCODE_PAGEUP, /* Cursor up by N pages */
SLCDCODE_PAGEDOWN, /* Cursor down by N pages */
/* Blinking */
SLCDCODE_BLINKSTART, /* Start blinking with current cursor position */
SLCDCODE_BLINKEND, /* End blinking after the current cursor position */
SLCDCODE_BLINKOFF /* Turn blinking off */
};
#define FIRST_SLCDCODE SLCDCODE_FWDDEL
#define LAST_SLCDCODE SLCDCODE_BLINKOFF
/* Values returned by slcd_decode() */
enum slcdret_e
{
SLCDRET_CHAR = 0, /* A normal character was returned */
SLCDRET_SPEC, /* A special SLCD action was returned */
SLCDRET_EOF /* An EOF (or possibly an error) occurred */
};
/****************************************************************************
* Public Types
****************************************************************************/
/* Working data needed by slcd_encode that must be provided and initialized
* by the caller.
*/
struct slcdstate_s
{
uint8_t nch; /* Number of characters in the buffer */
uint8_t ndx; /* Index to next character in the buffer */
uint8_t buf[5]; /* Buffer of ungotten data */
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
#ifdef __cplusplus
extern "C"
{
#endif
/****************************************************************************
* The following functions are intended for use by "producer", application
* code to encode information into driver I/O buffers.
****************************************************************************/
/****************************************************************************
* Name: slcd_put
*
* Description:
* Put one byte of normal character data into the output data stream.
*
* Input Parameters:
* ch - The character to be added to the output stream.
* stream - An instance of lib_outstream_s to do the low-level put
* operation.
*
* Returned Value:
* None
*
****************************************************************************/
#define slcd_put(ch, stream) (stream)->put((stream), (int)(ch))
/****************************************************************************
* Name: slcd_encode
*
* Description:
* Encode one special action into the output data stream
*
* Input Parameters:
* code - The action to be taken
* count - The 8-bit unsigned count value N associated with some actions
* stream - An instance of lib_outstream_s to do the low-level put
* operation.
*
* Returned Value:
* None
*
****************************************************************************/
void slcd_encode(enum slcdcode_e code, uint8_t count,
FAR struct lib_outstream_s *stream);
/****************************************************************************
* The following functions are intended for use by "consumer" SLCD driver
* code to remove and decode information from the application provided
* buffer.
****************************************************************************/
/****************************************************************************
* Name: slcd_decode
*
* Description:
* Get one byte of data or special command from the application provided
* input buffer.
*
* Input Parameters:
* stream - An instance of lib_instream_s to do the low-level get
* operation.
* state - A user provided buffer to support parsing. This structure
* should be cleared the first time that slcd_decode is called.
* pch - The location to save the returned value. This may be
* either a normal, character code or a special command from enum
* slcdcode_e, depending on the return value from slcd_decode()
* parg - The location to save the count argument that accompanies some
* special actions
*
* Returned Value:
*
* See enum slcdret_e
*
****************************************************************************/
enum slcdret_e slcd_decode(FAR struct lib_instream_s *stream,
FAR struct slcdstate_s *state, FAR uint8_t *pch,
FAR uint8_t *parg);
#ifdef __cplusplus
}
#endif
#endif /* CONFIG_LIB_SLCDCODEC */
#endif /* __INCLUDE_NUTTX_INPUT_SLCD_CODEC_H */
|
