terminal.h

Go to the documentation of this file.

/***************************************************************************
 * terminal.h
 * (C) 2010 Ivan Meleca
 * Based on original code written by Ruben Meleca
 * www.milos.it

#   This program is free software; you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation; either version 2 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program; if not, write to the Free Software
#   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

***************************************************************************/

#ifndef __TERMINAL_H__
#define __TERMINAL_H__

#include <plat_cpu.h>
#include "device.h"
#include "lock.h"

#if __CONFIG_COMPILE_TERMINAL

/*
 * Advance terminal structure declaration.
 */
struct __terminalTag;

typedef __VOID (__TERMINALRXCMD)(struct __terminalTag* term, __PSTRING cmd, __PSTRING params);

#define __TERMINAL_DEF_LINELEN      64

#define __TERMINAL_ECHO_ENABLED     0x01
#define __TERMINAL_DEBUG_COMMANDS   0x02
#define __TERMINAL_STARTED          0x04

typedef struct __terminalCommandTag
{
    __PSTRING cmd;
    __TERMINALRXCMD* func;
    struct __terminalCommandTag* next;

} __TERMINALCMD, *__PTERMINALCMD;

typedef struct __terminalTag
{
    __PSTRING name;                         
    __PDEVICE dv_in;                        
    __PDEVICE dv_out;                       
    __PSTRING tx_line;                      
    __PSTRING rx_line;                      
    __PSTRING prompt;                       
    u16 linelen;                            
    u16 rxoffs;                             
    u16 cursor;                             
    __PLOCK lock;                           
    u8 flags;                               
    __PTERMINALCMD cmds;                    
} __TERMINAL, *__PTERMINAL;

__PTERMINAL __terminalCreate(__PSTRING name, __PDEVICE in, __PDEVICE out, u16 linelen, __PSTRING prompt, u8 flags);
__BOOL __terminalStart(__PTERMINAL term);
__VOID __terminalWrite(__PTERMINAL term, __CONST __PSTRING str, ...);
__VOID __terminalWriteLine(__PTERMINAL term, __CONST __PSTRING str, ...);
__VOID __terminalOut(__PTERMINAL term, __BOOL crlf, __CONST __PSTRING str, __PSTRING args);
__VOID __terminalAddCommand(__PTERMINAL term, __PTERMINALCMD cmd, u8 count);
__VOID __terminalCreateCommand(__PTERMINAL term, __PSTRING cmd, __TERMINALRXCMD* func);

#endif /* __CONFIG_COMPILE_TERMINAL */

#endif /* __TERMINAL_H__ */