72 lines
2.5 KiB
C
72 lines
2.5 KiB
C
/* uart_console.h - uart console driver */
|
|
|
|
/*
|
|
* Copyright (c) 2011, 2014 Wind River Systems, Inc.
|
|
*
|
|
* 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 of Wind River Systems 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 HOLDER 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 _UART_CONSOLE__H_
|
|
#define _UART_CONSOLE__H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <nanokernel.h>
|
|
|
|
extern void uart_console_init(void);
|
|
|
|
#define MAX_LINE_LEN 1024
|
|
struct uart_console_input {
|
|
int __unused;
|
|
char line[MAX_LINE_LEN];
|
|
};
|
|
|
|
/** @brief Register uart input processing
|
|
*
|
|
* Input processing is started when string is typed in the console.
|
|
* Carriage return is translated to NULL making string always NULL
|
|
* terminated. Application before calling register function need to
|
|
* initialize two fifo queues mentioned below.
|
|
*
|
|
* @param avail nano_fifo queue keeping available input slots
|
|
* @param lines nano_fifo queue of entered lines which to be processed
|
|
* in the application code.
|
|
*
|
|
* @return None
|
|
*/
|
|
void uart_register_input(struct nano_fifo *avail, struct nano_fifo *lines);
|
|
|
|
void uart_console_isr(void *unused);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _UART_CONSOLE__H_ */
|