5fe6981c9a
libs/libc/pthread/pthread_spinlock.c: Resolve several TODO issues by accessing up_testset() via the boardctl() interface rather than attempting to call it directly.
configs/boardctl.c, include/sys/boardctl.h: Add access to architecture-specific up_testset() via boardctl().
arch/Kconfig's, sched/Kconfig, and include/nuttx/spinlock.h: Spinlocks are not available unless the architecture supports the up_testset() operation.
297 lines
12 KiB
C
297 lines
12 KiB
C
/****************************************************************************
|
|
* include/sys/boardctl.h
|
|
*
|
|
* Copyright (C) 2015-2019 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 __INCLUDE_SYS_BOARDCTL_H
|
|
#define __INCLUDE_SYS_BOARDCTL_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#include <stdint.h>
|
|
|
|
#include <nuttx/fs/ioctl.h>
|
|
|
|
#ifdef CONFIG_LIB_BOARDCTL
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
/* Common commands
|
|
*
|
|
* CMD: BOARDIOC_INIT
|
|
* DESCRIPTION: Perform one-time application initialization.
|
|
* ARG: The boardctl() argument is passed to the
|
|
* board_app_initialize() implementation without modification.
|
|
* The argument has no meaning to NuttX; the meaning of the
|
|
* argument is a contract between the board-specific
|
|
* initalization logic and the matching application logic.
|
|
* The value cold be such things as a mode enumeration value,
|
|
* a set of DIP switch switch settings, a pointer to
|
|
* configuration data read from a file or serial FLASH, or
|
|
* whatever you would like to do with it. Every
|
|
* implementation should accept zero/NULL as a default
|
|
* configuration.
|
|
* CONFIGURATION: CONFIG_LIB_BOARDCTL
|
|
* DEPENDENCIES: Board logic must provide board_app_initialize()
|
|
*
|
|
* CMD: BOARDIOC_POWEROFF
|
|
* DESCRIPTION: Power off the board
|
|
* ARG: Integer value providing power off status information
|
|
* CONFIGURATION: CONFIG_BOARDCTL_POWEROFF
|
|
* DEPENDENCIES: Board logic must provide the board_power_off() interface.
|
|
*
|
|
* CMD: BOARDIOC_RESET
|
|
* DESCRIPTION: Reset the board
|
|
* ARG: Integer value providing power off status information
|
|
* CONFIGURATION: CONFIG_BOARDCTL_RESET
|
|
* DEPENDENCIES: Board logic must provide the board_reset() interface.
|
|
*
|
|
* CMD: BOARDIOC_UNIQUEID
|
|
* DESCRIPTION: Return a unique ID associated with the board (such as a
|
|
* serial number or a MAC address).
|
|
* ARG: A writable array of size CONFIG_BOARDCTL_UNIQUEID_SIZE in
|
|
* which to receive the board unique ID.
|
|
* DEPENDENCIES: Board logic must provide the board_uniqueid() interface.
|
|
*
|
|
* CMD: BOARDIOC_APP_SYMTAB
|
|
* DESCRIPTION: Select the application symbol table. This symbol table
|
|
* provides the symbol definitions exported to application
|
|
* code from application space.
|
|
* ARG: A pointer to an instance of struct boardioc_symtab_s
|
|
* CONFIGURATION: CONFIG_BOARDCTL_APP_SYMTAB
|
|
* DEPENDENCIES: None
|
|
*
|
|
* CMD: BOARDIOC_OS_SYMTAB
|
|
* DESCRIPTION: Select the OS symbol table. This symbol table provides
|
|
* the symbol definitions exported by the OS to kernel
|
|
* modules.
|
|
* ARG: A pointer to an instance of struct boardioc_symtab_s
|
|
* CONFIGURATION: CONFIG_BOARDCTL_OS_SYMTAB
|
|
* DEPENDENCIES: None
|
|
*
|
|
* CMD: BOARDIOC_USBDEV_CONTROL
|
|
* DESCRIPTION: Manage USB device classes
|
|
* ARG: A pointer to an instance of struct boardioc_usbdev_ctrl_s
|
|
* CONFIGURATION: CONFIG_LIB_BOARDCTL && CONFIG_BOARDCTL_USBDEVCTRL
|
|
* DEPENDENCIES: Board logic must provide board_<usbdev>_initialize()
|
|
*
|
|
* CMD: BOARDIOC_NX_START
|
|
* DESCRIPTION: Start the NX server
|
|
* ARG: None
|
|
* CONFIGURATION: CONFIG_NX
|
|
* DEPENDENCIES: Base graphics logic provides nxmu_start()
|
|
*
|
|
* CMD: BOARDIOC_TESTSET
|
|
* DESCRIPTION: Access architecture-specific up_testset() operation
|
|
* ARG: A pointer to a write-able spinlock object. On success
|
|
* the preceding spinlock state is returned: 0=unlocked,
|
|
* 1=locked.
|
|
* CONFIGURATION: CONFIG_BOARDCTL_TESTSET
|
|
* DEPENDENCIES: Architecture-specific logic provides up_testset()
|
|
*/
|
|
|
|
#define BOARDIOC_INIT _BOARDIOC(0x0001)
|
|
#define BOARDIOC_FINALINIT _BOARDIOC(0x0002)
|
|
#define BOARDIOC_POWEROFF _BOARDIOC(0x0003)
|
|
#define BOARDIOC_RESET _BOARDIOC(0x0004)
|
|
#define BOARDIOC_UNIQUEID _BOARDIOC(0x0005)
|
|
#define BOARDIOC_APP_SYMTAB _BOARDIOC(0x0006)
|
|
#define BOARDIOC_OS_SYMTAB _BOARDIOC(0x0007)
|
|
#define BOARDIOC_USBDEV_CONTROL _BOARDIOC(0x0008)
|
|
#define BOARDIOC_NX_START _BOARDIOC(0x0009)
|
|
#define BOARDIOC_TESTSET _BOARDIOC(0x000a)
|
|
|
|
/* If CONFIG_BOARDCTL_IOCTL=y, then board-specific commands will be support.
|
|
* In this case, all commands not recognized by boardctl() will be forwarded
|
|
* to the board-provided board_ioctl() function.
|
|
*
|
|
* User defined board commands may begin with this value:
|
|
*/
|
|
|
|
#define BOARDIOC_USER _BOARDIOC(0x000b)
|
|
|
|
/****************************************************************************
|
|
* Public Type Definitions
|
|
****************************************************************************/
|
|
|
|
/* Structure used to pass arguments and get returned values from the
|
|
* BOARDIOC_GRAPHICS_SETUP command.
|
|
*/
|
|
|
|
#ifdef CONFIG_NX_LCDDRIVER
|
|
struct lcd_dev_s; /* Forward reference */
|
|
#else
|
|
struct fb_vtable_s; /* Forward reference */
|
|
#endif
|
|
|
|
struct boardioc_graphics_s
|
|
{
|
|
int devno; /* IN: Graphics device number */
|
|
#ifdef CONFIG_NX_LCDDRIVER
|
|
FAR struct lcd_dev_s *dev; /* OUT: LCD driver instance */
|
|
#else
|
|
FAR struct fb_vtable_s *dev; /* OUT: Framebuffer driver instance */
|
|
#endif
|
|
};
|
|
|
|
/* In order to full describe a symbol table, a vector containing the address
|
|
* of the symbol table and the number of elements in the symbol table is
|
|
* required.
|
|
*/
|
|
|
|
struct symtab_s; /* Forward reference */
|
|
struct boardioc_symtab_s
|
|
{
|
|
FAR struct symtab_s *symtab;
|
|
int nsymbols;
|
|
};
|
|
|
|
#ifdef CONFIG_BOARDCTL_USBDEVCTRL
|
|
/* This structure provides the argument BOARDIOC_USBDEV_CONTROL and
|
|
* describes which device should be controlled and what should be
|
|
* done.
|
|
*
|
|
* enum boardioc_usbdev_identifier_e: Identifies the USB device class.
|
|
* In the case of multiple instances of the USB device class, the
|
|
* specific instance is identifed by the 'inst' field of the structure.
|
|
*
|
|
* enum boardioc_usbdev_action_e: Identifies the action to peform on
|
|
* the USB device class instance.
|
|
*
|
|
* struct boardioc_usbdev_ctrl_s:
|
|
* - usbdev: A value from enum boardioc_usbdev_identifier_e that
|
|
* identifies the USB device class.
|
|
* - action: The action to be performed on the USB device class.
|
|
* - instance: If there are multiple instances of the USB device
|
|
* class, this identifies the particular instance. This is normally
|
|
* zero but could be non-zero if there are multiple USB device ports
|
|
* supported by the board. For CDC/ACM, this is the /dev/ttyACM minor
|
|
* number; For other devices this would be a port number.
|
|
* - handle: This value is returned by the BOARDIOC_USBDEV_CONNECT
|
|
* action and must be provided to the BOARDIOC_USBDEV_DISCONNECT
|
|
* action. It is not used with the BOARDIOC_USBDEV_INITIALIZE action.
|
|
*/
|
|
|
|
enum boardioc_usbdev_identifier_e
|
|
{
|
|
BOARDIOC_USBDEV_NONE = 0 /* Not valid */
|
|
#ifdef CONFIG_CDCACM
|
|
, BOARDIOC_USBDEV_CDCACM /* CDC/ACM */
|
|
#endif
|
|
#ifdef CONFIG_PL2303
|
|
, BOARDIOC_USBDEV_PL2303 /* PL2303 serial */
|
|
#endif
|
|
#ifdef CONFIG_USBMSC
|
|
, BOARDIOC_USBDEV_MSC /* Mass storage class */
|
|
#endif
|
|
#ifdef CONFIG_USBDEV_COMPOSITE
|
|
, BOARDIOC_USBDEV_COMPOSITE /* Composite device */
|
|
#endif
|
|
};
|
|
|
|
enum boardioc_usbdev_action_e
|
|
{
|
|
BOARDIOC_USBDEV_INITIALIZE = 0, /* Initialize USB device */
|
|
BOARDIOC_USBDEV_CONNECT, /* Connect the USB device */
|
|
BOARDIOC_USBDEV_DISCONNECT, /* Disconnect the USB device */
|
|
};
|
|
|
|
struct boardioc_usbdev_ctrl_s
|
|
{
|
|
uint8_t usbdev; /* See enum boardioc_usbdev_identifier_e */
|
|
uint8_t action; /* See enum boardioc_usbdev_action_e */
|
|
uint8_t instance; /* Identifies the USB device class instance */
|
|
uint8_t config; /* Configuration used with BOARDIOC_USBDEV_CONNECT */
|
|
FAR void **handle; /* Connection handle */
|
|
};
|
|
#endif /* CONFIG_BOARDCTL_USBDEVCTRL */
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: boardctl
|
|
*
|
|
* Description:
|
|
* In a small embedded system, there will typically be a much greater
|
|
* interaction between application and low-level board features. The
|
|
* canonically correct to implement such interactions is by implementing a
|
|
* character driver and performing the interactions via low level ioctl
|
|
* calls. This, however, may not be practical in many cases and will lead
|
|
* to "correct" but awkward implementations.
|
|
*
|
|
* boardctl() is non-standard OS interface to alleviate the problem. It
|
|
* basically circumvents the normal device driver ioctl interlace and allows
|
|
* the application to perform direct IOCTL-like calls to the board-specific
|
|
* logic. It is especially useful for setting up board operational and
|
|
* test configurations.
|
|
*
|
|
* Input Parameters:
|
|
* cmd - Identifies the board command to be executed
|
|
* arg - The argument that accompanies the command. The nature of the
|
|
* argument is determined by the specific command.
|
|
*
|
|
* Returned Value:
|
|
* On success zero (OK) is returned; -1 (ERROR) is returned on failure
|
|
* with the errno variable to to indicate the nature of the failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int boardctl(unsigned int cmd, uintptr_t arg);
|
|
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* CONFIG_LIB_BOARDCTL */
|
|
#endif /* __INCLUDE_SYS_BOARDCTL_H */
|