a1f980bc9d
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4948 42af7a65-404d-4744-a932-0658087f49c3
122 lines
4.3 KiB
C
122 lines
4.3 KiB
C
/****************************************************************************
|
|
* apps/include/nsh.h
|
|
*
|
|
* Copyright (C) 2011 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 __APPS_INCLUDE_NSH_H
|
|
#define __APPS_INCLUDE_NSH_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-Processor Definitions
|
|
****************************************************************************/
|
|
|
|
#if CONFIG_RR_INTERVAL > 0
|
|
# define SCHED_NSH SCHED_RR
|
|
#else
|
|
# define SCHED_NSH SCHED_FIFO
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C" {
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: nsh_initialize
|
|
*
|
|
* Description:
|
|
* This nterfaces is used to initialize the NuttShell (NSH).
|
|
* nsh_initialize() should be called one during application start-up prior
|
|
* to executing either nsh_consolemain() or nsh_telnetstart().
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
EXTERN void nsh_initialize(void);
|
|
|
|
/****************************************************************************
|
|
* Name: nsh_consolemain
|
|
*
|
|
* Description:
|
|
* This interfaces maybe to called or started with task_start to start a
|
|
* single an NSH instance that operates on stdin and stdout (/dev/console).
|
|
* This function does not return.
|
|
*
|
|
* Input Parameters:
|
|
* Standard task start-up arguements. These are not used. argc may be
|
|
* zero and argv may be NULL.
|
|
*
|
|
* Returned Values:
|
|
* This function does not normally return. exit() is usually called to
|
|
* terminate the NSH session. This function will return in the event of
|
|
* an error. In that case, a nonzero value is returned (1).
|
|
*
|
|
****************************************************************************/
|
|
|
|
EXTERN int nsh_consolemain(int argc, char *argv[]);
|
|
|
|
/* nsh_telnetstart() starts a telnet daemon that will allow multiple
|
|
* NSH connections via telnet. This function returns immediately after
|
|
* the daemon has been started.
|
|
*/
|
|
|
|
EXTERN int nsh_telnetstart(void);
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __APPS_INCLUDE_NSH_H */
|