310 lines
10 KiB
C
310 lines
10 KiB
C
/****************************************************************************
|
|
* apps/include/nshlib/nshlib.h
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __APPS_INCLUDE_NSHLIB_NSHLIB_H
|
|
#define __APPS_INCLUDE_NSHLIB_NSHLIB_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <arpa/inet.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_USBCONDEV.
|
|
*/
|
|
|
|
# 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 interface is used to initialize the NuttShell (NSH).
|
|
* nsh_initialize() should be called once 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 interface may be called or started with task_start to start a
|
|
* single 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 non-zero value is returned (EXIT_FAILURE=1).
|
|
*
|
|
****************************************************************************/
|
|
|
|
int nsh_consolemain(int argc, FAR char *argv[]);
|
|
|
|
/****************************************************************************
|
|
* Name: nsh_telnetmain
|
|
*
|
|
* Description:
|
|
* This interface may be called or started with task_start to start a
|
|
* single NSH instance that operates on stdin and stdout for telnet daemon.
|
|
* This function does not return.
|
|
*
|
|
* 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 non-zero value is returned (EXIT_FAILURE=1).
|
|
|
|
****************************************************************************/
|
|
|
|
int nsh_telnetmain(int argc, FAR 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:
|
|
* family - Provides the IP family to use by the server. May be either
|
|
* AF_INET or AF_INET6. This is needed because both both may be
|
|
* enabled in the configuration.
|
|
*
|
|
* All of the other properties of the Telnet daemon are controlled by
|
|
* NuttX configuration settings.
|
|
*
|
|
* Returned Values:
|
|
* The task ID of the Telnet daemon was successfully started. A negated
|
|
* errno value will be returned on failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int nsh_telnetstart(sa_family_t family);
|
|
|
|
/****************************************************************************
|
|
* Name: platform_motd
|
|
*
|
|
* Description:
|
|
* If CONFIG_NSH_PLATFORM_MOTD is defined, then platform-specific logic
|
|
* must provide this function in order to obtain the Message of the Day
|
|
* (MOTD)
|
|
*
|
|
* Input Parameters:
|
|
* buffer - A caller allocated buffer in which to receive the MOTD
|
|
* buflen - The length in bytes of the caller allocated buffer
|
|
*
|
|
* Returned value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NSH_PLATFORM_MOTD
|
|
void platform_motd(FAR char *buffer, size_t buflen);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: platform_skip_login
|
|
*
|
|
* Description:
|
|
* If CONFIG_NSH_PLATFORM_SKIP_LOGIN is defined, then platform-specific
|
|
* logic must provide this function in order to skip login.
|
|
*
|
|
* Input Parameters:
|
|
* None
|
|
*
|
|
* Returned value:
|
|
* OK - need to skip login
|
|
* else - no need to skip login
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NSH_PLATFORM_SKIP_LOGIN
|
|
int platform_skip_login(void);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: platform_challenge
|
|
*
|
|
* Description:
|
|
* If CONFIG_NSH_PLATFORM_CHALLENGE is defined, then platform-specific
|
|
* logic must provide this function in order get the challenge.
|
|
*
|
|
* Input Parameters:
|
|
* buffer - A caller allocated buffer in which to receive the challenge
|
|
* buflen - The length in bytes of the caller allocated buffer
|
|
*
|
|
* Returned value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NSH_PLATFORM_CHALLENGE
|
|
void platform_challenge(FAR char *buffer, size_t buflen);
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: platform_user_verify
|
|
*
|
|
* Description:
|
|
* If CONFIG_NSH_LOGIN_PLATFORM is defined, then platform-specific logic
|
|
* must provide this function in order verify user credentials as part of
|
|
* the login process.
|
|
*
|
|
* Input Parameters:
|
|
* username/password - User credentials to be verified.
|
|
*
|
|
* Returned value:
|
|
* 1 - The user credentials are verified
|
|
* 0 - The user credentials are incorrect
|
|
* <0 - An error occurred. The returned value is a negated errno number.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_NSH_LOGIN_PLATFORM
|
|
#ifdef CONFIG_NSH_PLATFORM_CHALLENGE
|
|
int platform_user_verify(FAR const char *username, FAR const char *challenge,
|
|
FAR const char *password);
|
|
#else
|
|
int platform_user_verify(FAR const char *username, FAR const char *password);
|
|
#endif
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: nsh_system
|
|
*
|
|
* Description:
|
|
* This is the NSH-specific implementation of the standard system()
|
|
* command.
|
|
*
|
|
* NOTE: This assumes that other NSH instances have previously ran and so
|
|
* common NSH logic is already initialized.
|
|
*
|
|
* Input Parameters:
|
|
* Standard task start-up arguments. Expects argc == 2 with argv[1] being
|
|
* the command to execute
|
|
*
|
|
* Returned Values:
|
|
* EXIT_SUCCESS or EXIT_FAILURE
|
|
*
|
|
****************************************************************************/
|
|
|
|
int nsh_system(int argc, FAR char *argv[]);
|
|
|
|
/****************************************************************************
|
|
* Name: nsh_system_ctty
|
|
*
|
|
* Description:
|
|
* This is the NSH-specific implementation of the standard system()
|
|
* command.
|
|
*
|
|
* NOTE:
|
|
* This difference with nsh_system: newconsole set isctty true
|
|
*
|
|
* Input Parameters:
|
|
* Standard task start-up arguments. Expects argc == 2 with argv[1] being
|
|
* the command to execute
|
|
*
|
|
* Returned Values:
|
|
* EXIT_SUCCESS or EXIT_FAILURE
|
|
*
|
|
****************************************************************************/
|
|
|
|
int nsh_system_ctty(int argc, FAR char *argv[]);
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __APPS_INCLUDE_NSHLIB_NSHLIB_H */
|