258 lines
9.0 KiB
C
258 lines
9.0 KiB
C
/************************************************************************************
|
|
* 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>
|
|
#include <nuttx/fs/ioctl.h>
|
|
|
|
#ifdef CONFIG_LIB_SLCDCODEC
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
/* IOCTL commands that may be supported by some SLCD drivers */
|
|
|
|
/* SLCDIOC_GEOMETRY: Get the SLCD geometry (rows x characters)
|
|
*
|
|
* argument: Pointer to struct slcd_geometry_s in which values will be
|
|
* returned
|
|
*/
|
|
|
|
#define SLCDIOC_GEOMETRY _SLCDIOC(0x0001)
|
|
|
|
/* SLCDIOC_SETBAR: Set bars on a bar display
|
|
*
|
|
* argument: 32-bit bitset, with each bit corresponding to one bar.
|
|
*/
|
|
|
|
#define SLCDIOC_SETBAR _SLCDIOC(0x0002)
|
|
|
|
/* SLCDIOC_GETCONTRAST: Get the current contrast setting
|
|
*
|
|
* argument: Pointer type int that will receive the current contrast
|
|
* setting
|
|
*/
|
|
|
|
#define SLCDIOC_GETCONTRAST _SLCDIOC(0x0003)
|
|
|
|
/* SLCDIOC_MAXCONTRAST: Get the maximum contrast setting
|
|
*
|
|
* argument: Pointer type int that will receive the maximum contrast
|
|
* setting
|
|
*/
|
|
|
|
#define SLCDIOC_MAXCONTRAST _SLCDIOC(0x0004)
|
|
|
|
/* SLCDIOC_SETCONTRAST: Set the contrast to a new value
|
|
*
|
|
* argument: The new contrast value
|
|
*/
|
|
|
|
#define SLCDIOC_SETCONTRAST _SLCDIOC(0x0005)
|
|
|
|
/****************************************************************************
|
|
* 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 */
|
|
};
|
|
|
|
/* Used with the SLCDIOC_GEOMETRY ioctl call */
|
|
|
|
struct slcd_geometry_s
|
|
{
|
|
uint16_t nrows; /* Number of the rows on the SLCD */
|
|
uint16_t ncolumns; /* Number of characters in one row on the SLCD */
|
|
uint8_t nbars; /* Number of bars supported by the SLCD */
|
|
};
|
|
|
|
/* 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 */
|
|
|