diff options
Diffstat (limited to 'apps/include/nsh.h')
-rw-r--r-- | apps/include/nsh.h | 166 |
1 files changed, 0 insertions, 166 deletions
diff --git a/apps/include/nsh.h b/apps/include/nsh.h deleted file mode 100644 index 8e469a555..000000000 --- a/apps/include/nsh.h +++ /dev/null @@ -1,166 +0,0 @@ -/**************************************************************************** - * apps/include/nsh.h - * - * Copyright (C) 2011, 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 __APPS_INCLUDE_NSH_H -#define __APPS_INCLUDE_NSH_H - -/**************************************************************************** - * Included Files - ****************************************************************************/ - -#include <nuttx/config.h> - -/**************************************************************************** - * Pre-Processor Definitions - ****************************************************************************/ -/* If a USB device is selected for the NSH console then we need to handle some - * special start-up conditions. - */ - -#undef HAVE_USB_CONSOLE -#if defined(CONFIG_USBDEV) - -/* Check for a PL2303 serial console. Use console device "/dev/console". */ - -# if defined(CONFIG_PL2303) && defined(CONFIG_PL2303_CONSOLE) -# define HAVE_USB_CONSOLE 1 - -/* Check for a CDC/ACM serial console. Use console device "/dev/console". */ - -# elif defined(CONFIG_CDCACM) && defined(CONFIG_CDCACM_CONSOLE) -# define HAVE_USB_CONSOLE 1 - -/* Check for a generic USB console. In this case, the USB console device - * must be provided in CONFIG_NSH_CONDEV. - */ - -# elif defined(CONFIG_NSH_USBCONSOLE) -# define HAVE_USB_CONSOLE 1 -# endif -#endif - -#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 - * - ****************************************************************************/ - -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. This - * function does not return. - * - * This function handles generic /dev/console character devices, or - * special USB console devices. The USB console requires some special - * operations to handle the cases where the session is lost when the - * USB device is unplugged and restarted when the USB device is plugged - * in again. - * - * Input Parameters: - * Standard task start-up arguments. 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 (EXIT_FAILURE=1). - * - ****************************************************************************/ - -int nsh_consolemain(int argc, char *argv[]); - -/**************************************************************************** - * Name: nsh_telnetstart - * - * Description: - * nsh_telnetstart() starts the Telnet daemon that will allow multiple - * NSH connections via Telnet. This function returns immediately after - * the daemon has been started. - * - * Input Parameters: - * None. All of the properties of the Telnet daemon are controlled by - * NuttX configuration setting. - * - * Returned Values: - * The task ID of the Telnet daemon was successfully started. A negated - * errno value will be returned on failure. - * - ****************************************************************************/ - -int nsh_telnetstart(void); - -#undef EXTERN -#ifdef __cplusplus -} -#endif - -#endif /* __APPS_INCLUDE_NSH_H */ |