2015-03-31 19:25:52 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* include/sys/boardctl.h
|
|
|
|
*
|
2021-02-03 11:33:49 +01:00
|
|
|
* 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
|
2015-03-31 19:25:52 +02:00
|
|
|
*
|
2021-02-03 11:33:49 +01:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2015-03-31 19:25:52 +02:00
|
|
|
*
|
2021-02-03 11:33:49 +01:00
|
|
|
* 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.
|
2015-03-31 19:25:52 +02:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#ifndef __INCLUDE_SYS_BOARDCTL_H
|
|
|
|
#define __INCLUDE_SYS_BOARDCTL_H
|
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Included Files
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
#include <nuttx/fs/ioctl.h>
|
|
|
|
|
2019-11-04 14:41:25 +01:00
|
|
|
#ifdef CONFIG_PM
|
2019-11-04 23:59:18 +01:00
|
|
|
# include <nuttx/power/pm.h>
|
2019-11-04 14:41:25 +01:00
|
|
|
#endif
|
|
|
|
|
2019-04-02 14:32:55 +02:00
|
|
|
#ifdef CONFIG_VNCSERVER
|
|
|
|
# include <nuttx/nx/nx.h>
|
|
|
|
#endif
|
|
|
|
|
2019-03-06 16:17:19 +01:00
|
|
|
#ifdef CONFIG_NXTERM
|
|
|
|
# include <nuttx/nx/nxterm.h>
|
|
|
|
#endif
|
|
|
|
|
2024-08-01 09:15:43 +02:00
|
|
|
#ifdef CONFIG_BOARDCTL_SPINLOCK
|
|
|
|
# include <nuttx/spinlock.h>
|
|
|
|
#endif
|
|
|
|
|
2021-08-01 09:00:54 +02:00
|
|
|
#ifdef CONFIG_BOARDCTL
|
2015-03-31 19:25:52 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Pre-processor Definitions
|
|
|
|
****************************************************************************/
|
2019-08-26 02:37:23 +02:00
|
|
|
|
2015-03-31 19:25:52 +02:00
|
|
|
/* Common commands
|
|
|
|
*
|
|
|
|
* CMD: BOARDIOC_INIT
|
|
|
|
* DESCRIPTION: Perform one-time application initialization.
|
2016-05-24 18:51:22 +02:00
|
|
|
* 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
|
2019-08-21 17:32:59 +02:00
|
|
|
* initialization logic and the matching application logic.
|
2020-05-14 17:52:49 +02:00
|
|
|
* The value could be such things as a mode enumeration value,
|
2016-05-24 18:51:22 +02:00
|
|
|
* 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.
|
2021-08-01 09:00:54 +02:00
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL
|
2016-05-24 18:51:22 +02:00
|
|
|
* DEPENDENCIES: Board logic must provide board_app_initialize()
|
2015-03-31 19:25:52 +02:00
|
|
|
*
|
2015-07-03 01:09:54 +02:00
|
|
|
* CMD: BOARDIOC_POWEROFF
|
|
|
|
* DESCRIPTION: Power off the board
|
|
|
|
* ARG: Integer value providing power off status information
|
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL_POWEROFF
|
2015-11-18 14:31:53 +01:00
|
|
|
* DEPENDENCIES: Board logic must provide the board_power_off() interface.
|
2015-07-03 01:09:54 +02:00
|
|
|
*
|
2015-07-04 18:39:24 +02:00
|
|
|
* CMD: BOARDIOC_RESET
|
|
|
|
* DESCRIPTION: Reset the board
|
|
|
|
* ARG: Integer value providing power off status information
|
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL_RESET
|
2015-11-18 14:31:53 +01:00
|
|
|
* DEPENDENCIES: Board logic must provide the board_reset() interface.
|
|
|
|
*
|
2019-11-04 14:41:25 +01:00
|
|
|
* CMD: BOARDIOC_PM_CONTROL
|
|
|
|
* DESCRIPTION: Manage power state transition and query
|
|
|
|
* ARG: A pointer to an instance of struct boardioc_pm_ctrl_s
|
|
|
|
* CONFIGURATION: CONFIG_PM
|
|
|
|
* DEPENDENCIES: None
|
|
|
|
*
|
2015-11-18 14:31:53 +01:00
|
|
|
* 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.
|
2015-07-04 18:39:24 +02:00
|
|
|
*
|
2019-10-26 17:35:32 +02:00
|
|
|
* CMD: BOARDIOC_MKRD
|
|
|
|
* DESCRIPTION: Create a RAM disk
|
|
|
|
* ARG: Pointer to read-only instance of struct boardioc_mkrd_s.
|
2019-10-26 21:42:40 +02:00
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL_MKRD
|
|
|
|
* DEPENDENCIES: None
|
|
|
|
*
|
|
|
|
* CMD: BOARDIOC_ROMDISK
|
2021-03-25 17:16:42 +01:00
|
|
|
* DESCRIPTION: Register a ROM disk
|
2019-10-26 21:42:40 +02:00
|
|
|
* ARG: Pointer to read-only instance of struct boardioc_romdisk_s.
|
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL_ROMDISK
|
2019-10-26 17:35:32 +02:00
|
|
|
* DEPENDENCIES: None
|
|
|
|
*
|
2015-12-13 15:10:01 +01:00
|
|
|
* CMD: BOARDIOC_APP_SYMTAB
|
|
|
|
* DESCRIPTION: Select the application symbol table. This symbol table
|
|
|
|
* provides the symbol definitions exported to application
|
|
|
|
* code from application space.
|
2015-08-23 19:33:29 +02:00
|
|
|
* ARG: A pointer to an instance of struct boardioc_symtab_s
|
2015-12-13 15:10:01 +01:00
|
|
|
* 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
|
2015-08-23 18:44:04 +02:00
|
|
|
* DEPENDENCIES: None
|
|
|
|
*
|
2019-08-26 00:58:43 +02:00
|
|
|
* CMD: BOARDIOC_BUILTINS
|
|
|
|
* DESCRIPTION: Provide the user-space list of built-in applications for
|
|
|
|
* use by BINFS in protected mode. Normally this is small
|
|
|
|
* set of globals provided by user-space logic. It provides
|
|
|
|
* name-value pairs for associating built-in application
|
|
|
|
* names with user-space entry point addresses. These
|
|
|
|
* globals are only needed for use by BINFS which executes
|
|
|
|
* built-in applications from kernel-space in PROTECTED mode.
|
|
|
|
* In the FLAT build, the user space globals are readily
|
|
|
|
* available. (BINFS is not supportable in KERNEL mode since
|
|
|
|
* user-space address have no general meaning that
|
|
|
|
* configuration).
|
|
|
|
* ARG: A pointer to an instance of struct boardioc_builtin_s
|
|
|
|
* CONFIGURATION: This BOARDIOC command is always available when
|
|
|
|
* CONFIG_BUILTIN is enabled, but does nothing unless
|
2022-02-13 13:07:18 +01:00
|
|
|
* CONFIG_BUILD_PROTECTED is also selected.
|
2019-08-26 00:58:43 +02:00
|
|
|
* DEPENDENCIES: None
|
|
|
|
*
|
2016-03-25 17:52:39 +01:00
|
|
|
* CMD: BOARDIOC_USBDEV_CONTROL
|
|
|
|
* DESCRIPTION: Manage USB device classes
|
|
|
|
* ARG: A pointer to an instance of struct boardioc_usbdev_ctrl_s
|
2021-08-01 09:00:54 +02:00
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL && CONFIG_BOARDCTL_USBDEVCTRL
|
2016-03-25 17:52:39 +01:00
|
|
|
* DEPENDENCIES: Board logic must provide board_<usbdev>_initialize()
|
|
|
|
*
|
2016-12-01 20:52:13 +01:00
|
|
|
* CMD: BOARDIOC_NX_START
|
2019-03-04 21:22:50 +01:00
|
|
|
* DESCRIPTION: Start the NX server
|
2019-03-10 20:50:05 +01:00
|
|
|
* ARG: Integer display number to be served by this NXMU instance.
|
2017-10-15 17:34:08 +02:00
|
|
|
* CONFIGURATION: CONFIG_NX
|
2019-02-04 23:51:48 +01:00
|
|
|
* DEPENDENCIES: Base graphics logic provides nxmu_start()
|
2019-03-04 21:22:50 +01:00
|
|
|
*
|
2019-04-02 14:32:55 +02:00
|
|
|
* CMD: BOARDIOC_VNC_START
|
|
|
|
* DESCRIPTION: Start the NX server and framebuffer driver.
|
|
|
|
* ARG: A reference readable instance of struct
|
|
|
|
* boardioc_vncstart_s
|
|
|
|
* CONFIGURATION: CONFIG_VNCSERVER
|
2021-12-30 18:55:40 +01:00
|
|
|
* DEPENDENCIES: VNC server provides nx_vnc_fbinitialize()
|
2019-04-02 14:32:55 +02:00
|
|
|
*
|
2019-03-06 16:17:19 +01:00
|
|
|
* CMD: BOARDIOC_NXTERM
|
|
|
|
* DESCRIPTION: Create an NX terminal device
|
|
|
|
* ARG: A reference readable/writable instance of struct
|
|
|
|
* boardioc_nxterm_create_s
|
|
|
|
* CONFIGURATION: CONFIG_NXTERM
|
|
|
|
* DEPENDENCIES: Base NX terminal logic provides nx_register() and
|
|
|
|
* nxtk_register()
|
|
|
|
*
|
2019-05-16 19:54:38 +02:00
|
|
|
* CMD: BOARDIOC_NXTERM_IOCTL
|
|
|
|
* DESCRIPTION: Create an NX terminal IOCTL command. Normal IOCTLs
|
|
|
|
* cannot be be performed in most graphics contexts since
|
|
|
|
* the depend on the task holding an open file descriptor
|
|
|
|
* ARG: A reference readable/writable instance of struct
|
|
|
|
* boardioc_nxterm_ioctl_s
|
2019-03-06 22:21:29 +01:00
|
|
|
* CONFIGURATION: CONFIG_NXTERM
|
2019-05-16 19:54:38 +02:00
|
|
|
* DEPENDENCIES: Base NX terminal logic provides nxterm_ioctl_tap()
|
2019-03-06 22:21:29 +01:00
|
|
|
*
|
2024-08-01 09:15:43 +02:00
|
|
|
* CMD: BOARDIOC_SPINLOCK
|
|
|
|
* DESCRIPTION: spinlock specific operation
|
|
|
|
* ARG: A pointer to a write-able boardioc_spinlock_s
|
|
|
|
*
|
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL_SPINLOCK
|
|
|
|
* DEPENDENCIES: spinlock specific logic
|
2022-03-30 05:50:19 +02:00
|
|
|
*
|
|
|
|
* CMD: BOARDIOC_RESET_CAUSE
|
|
|
|
* DESCRIPTION: Get the cause of last-time board reset
|
|
|
|
* ARG: A pointer to an instance of struct boardioc_reset_cause_s
|
|
|
|
* CONFIGURATION: CONFIG_BOARDCTL_RESET_CAUSE
|
|
|
|
* DEPENDENCIES: Board logic must provide the board_reset_cause() interface.
|
2015-03-31 19:25:52 +02:00
|
|
|
*/
|
|
|
|
|
2015-03-31 21:21:25 +02:00
|
|
|
#define BOARDIOC_INIT _BOARDIOC(0x0001)
|
2018-08-28 23:34:31 +02:00
|
|
|
#define BOARDIOC_FINALINIT _BOARDIOC(0x0002)
|
|
|
|
#define BOARDIOC_POWEROFF _BOARDIOC(0x0003)
|
|
|
|
#define BOARDIOC_RESET _BOARDIOC(0x0004)
|
2019-11-04 14:41:25 +01:00
|
|
|
#define BOARDIOC_PM_CONTROL _BOARDIOC(0x0005)
|
|
|
|
#define BOARDIOC_UNIQUEID _BOARDIOC(0x0006)
|
|
|
|
#define BOARDIOC_MKRD _BOARDIOC(0x0007)
|
|
|
|
#define BOARDIOC_ROMDISK _BOARDIOC(0x0008)
|
|
|
|
#define BOARDIOC_APP_SYMTAB _BOARDIOC(0x0009)
|
|
|
|
#define BOARDIOC_OS_SYMTAB _BOARDIOC(0x000a)
|
|
|
|
#define BOARDIOC_BUILTINS _BOARDIOC(0x000b)
|
|
|
|
#define BOARDIOC_USBDEV_CONTROL _BOARDIOC(0x000c)
|
|
|
|
#define BOARDIOC_NX_START _BOARDIOC(0x000d)
|
|
|
|
#define BOARDIOC_VNC_START _BOARDIOC(0x000e)
|
|
|
|
#define BOARDIOC_NXTERM _BOARDIOC(0x000f)
|
|
|
|
#define BOARDIOC_NXTERM_IOCTL _BOARDIOC(0x0010)
|
2024-08-01 09:15:43 +02:00
|
|
|
#define BOARDIOC_SPINLOCK _BOARDIOC(0x0011)
|
2021-07-07 11:06:33 +02:00
|
|
|
#define BOARDIOC_UNIQUEKEY _BOARDIOC(0x0012)
|
2021-07-20 16:12:28 +02:00
|
|
|
#define BOARDIOC_SWITCH_BOOT _BOARDIOC(0x0013)
|
2021-07-24 00:31:37 +02:00
|
|
|
#define BOARDIOC_BOOT_IMAGE _BOARDIOC(0x0014)
|
2022-03-30 05:50:19 +02:00
|
|
|
#define BOARDIOC_RESET_CAUSE _BOARDIOC(0x0015)
|
2024-03-28 11:27:31 +01:00
|
|
|
#define BOARDIOC_IRQ_AFFINITY _BOARDIOC(0x0016)
|
2015-03-31 23:00:23 +02:00
|
|
|
|
2017-10-15 15:56:04 +02:00
|
|
|
/* If CONFIG_BOARDCTL_IOCTL=y, then board-specific commands will be support.
|
2015-03-31 23:00:23 +02:00
|
|
|
* 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:
|
|
|
|
*/
|
|
|
|
|
2024-03-28 11:27:31 +01:00
|
|
|
#define BOARDIOC_USER _BOARDIOC(0x0017)
|
2015-03-31 19:25:52 +02:00
|
|
|
|
|
|
|
/****************************************************************************
|
|
|
|
* Public Type Definitions
|
|
|
|
****************************************************************************/
|
|
|
|
|
2019-04-02 14:32:55 +02:00
|
|
|
/* Structures used with IOCTL commands */
|
2015-04-01 00:20:21 +02:00
|
|
|
|
2019-11-04 14:41:25 +01:00
|
|
|
#ifdef CONFIG_PM
|
|
|
|
/* Arguments passed with the BOARDIOC_PM_CONTROL command */
|
|
|
|
|
|
|
|
enum boardioc_action_e
|
|
|
|
{
|
|
|
|
BOARDIOC_PM_ACTIVITY = 0,
|
|
|
|
BOARDIOC_PM_STAY,
|
|
|
|
BOARDIOC_PM_RELAX,
|
|
|
|
BOARDIOC_PM_STAYCOUNT,
|
2021-03-23 16:57:20 +01:00
|
|
|
BOARDIOC_PM_QUERYSTATE,
|
2021-03-25 09:59:13 +01:00
|
|
|
BOARDIOC_PM_CHANGESTATE,
|
|
|
|
BOARDIOC_PM_CHECKSTATE
|
2019-11-04 14:41:25 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
struct boardioc_pm_ctrl_s
|
|
|
|
{
|
|
|
|
uint32_t action;
|
|
|
|
uint32_t domain;
|
|
|
|
uint32_t state;
|
|
|
|
uint32_t count;
|
|
|
|
uint32_t priority;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2019-10-26 21:42:40 +02:00
|
|
|
#ifdef CONFIG_BOARDCTL_MKRD
|
2019-10-26 17:35:32 +02:00
|
|
|
/* Describes the RAM disk to be created */
|
|
|
|
|
|
|
|
struct boardioc_mkrd_s
|
|
|
|
{
|
|
|
|
uint8_t minor; /* Minor device number of the RAM disk. */
|
|
|
|
uint32_t nsectors; /* The number of sectors in the RAM disk */
|
|
|
|
uint16_t sectsize; /* The size of one sector in bytes */
|
|
|
|
uint8_t rdflags; /* See RD_FLAGS_* definitions in include/nuttx/ramdisk.h */
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2019-10-26 21:42:40 +02:00
|
|
|
#ifdef CONFIG_BOARDCTL_ROMDISK
|
2019-10-26 22:29:24 +02:00
|
|
|
/* Describes the ROM disk image to be registered.
|
|
|
|
*
|
|
|
|
* The image points to a image of the file system in some read-only memory.
|
|
|
|
* This image must conform to certain requirements: (1) it must be
|
|
|
|
* accessible to the kernel code with no special address mapping, and (2)
|
|
|
|
* it must be virtually contiguous.
|
|
|
|
*/
|
2019-10-26 21:42:40 +02:00
|
|
|
|
|
|
|
struct boardioc_romdisk_s
|
|
|
|
{
|
|
|
|
uint8_t minor; /* Minor device number of the RAM disk. */
|
|
|
|
uint32_t nsectors; /* The number of sectors in the RAM disk */
|
|
|
|
uint16_t sectsize; /* The size of one sector in bytes */
|
|
|
|
FAR const uint8_t *image;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2024-08-01 09:15:43 +02:00
|
|
|
#ifdef CONFIG_BOARDCTL_SPINLOCK
|
|
|
|
enum boardioc_spinlock_e
|
|
|
|
{
|
|
|
|
BOARDIOC_SPINLOCK_LOCK = 0, /* call up_irq_save or/and spin_lock */
|
|
|
|
BOARDIOC_SPINLOCK_TRYLOCK = 1, /* call up_irq_save or/and spin_trylock */
|
|
|
|
BOARDIOC_SPINLOCK_UNLOCK = 2, /* call up_irq_restore or/and spin_unlock */
|
|
|
|
};
|
|
|
|
|
|
|
|
struct boardioc_spinlock_s
|
|
|
|
{
|
|
|
|
enum boardioc_spinlock_e action; /* see enum boardioc_spinlock_e */
|
|
|
|
FAR irqstate_t *flags; /* whether we need to disable int */
|
|
|
|
FAR volatile spinlock_t *lock; /* whether we need to call spinlock */
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2015-08-23 19:33:29 +02:00
|
|
|
/* 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.
|
|
|
|
*/
|
|
|
|
|
2019-08-26 00:58:43 +02:00
|
|
|
struct symtab_s; /* Forward reference */
|
2015-08-23 19:33:29 +02:00
|
|
|
struct boardioc_symtab_s
|
|
|
|
{
|
2023-07-02 18:19:22 +02:00
|
|
|
FAR const struct symtab_s *symtab;
|
2015-08-23 19:33:29 +02:00
|
|
|
int nsymbols;
|
|
|
|
};
|
|
|
|
|
2019-08-26 00:58:43 +02:00
|
|
|
#ifdef CONFIG_BUILTIN
|
|
|
|
/* Arguments passed with the BOARDIOC_BUILTIN command */
|
|
|
|
|
|
|
|
struct builtin_s; /* Forward reference */
|
|
|
|
struct boardioc_builtin_s
|
|
|
|
{
|
2019-08-26 02:37:23 +02:00
|
|
|
FAR const struct builtin_s *builtins;
|
2019-08-26 00:58:43 +02:00
|
|
|
int count;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2016-03-25 17:52:39 +01:00
|
|
|
#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
|
2019-08-26 02:37:23 +02:00
|
|
|
* specific instance is identified by the 'inst' field of the structure.
|
2016-03-25 17:52:39 +01:00
|
|
|
*
|
2019-08-26 02:37:23 +02:00
|
|
|
* enum boardioc_usbdev_action_e: Identifies the action to perform on
|
2016-03-25 17:52:39 +01:00
|
|
|
* 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 */
|
2023-07-29 10:05:16 +02:00
|
|
|
#ifdef CONFIG_USBADB
|
|
|
|
, BOARDIOC_USBDEV_ADB /* ADB */
|
2023-12-17 08:29:52 +01:00
|
|
|
, BOARDIOC_USBDEV_FASTBOOT = BOARDIOC_USBDEV_ADB
|
2023-07-29 10:05:16 +02:00
|
|
|
#endif
|
2016-03-25 21:23:27 +01:00
|
|
|
#ifdef CONFIG_CDCACM
|
2016-03-25 17:52:39 +01:00
|
|
|
, BOARDIOC_USBDEV_CDCACM /* CDC/ACM */
|
|
|
|
#endif
|
2016-03-25 23:01:59 +01:00
|
|
|
#ifdef CONFIG_PL2303
|
|
|
|
, BOARDIOC_USBDEV_PL2303 /* PL2303 serial */
|
|
|
|
#endif
|
2016-03-25 17:52:39 +01:00
|
|
|
#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 */
|
2017-07-16 16:43:17 +02:00
|
|
|
uint8_t config; /* Configuration used with BOARDIOC_USBDEV_CONNECT */
|
2016-03-25 17:52:39 +01:00
|
|
|
FAR void **handle; /* Connection handle */
|
|
|
|
};
|
|
|
|
#endif /* CONFIG_BOARDCTL_USBDEVCTRL */
|
|
|
|
|
2019-04-02 14:32:55 +02:00
|
|
|
#ifdef CONFIG_VNCSERVER
|
|
|
|
/* Argument passed with the BOARDIOC_VNC_START command */
|
|
|
|
|
|
|
|
struct boardioc_vncstart_s
|
|
|
|
{
|
|
|
|
int display; /* Display number */
|
|
|
|
NXHANDLE handle; /* Handle returned by nx_connect */
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2019-03-06 16:17:19 +01:00
|
|
|
#ifdef CONFIG_NXTERM
|
2019-04-02 14:32:55 +02:00
|
|
|
/* Arguments passed with the BOARDIOC_NXTERM command */
|
|
|
|
|
2019-03-06 16:17:19 +01:00
|
|
|
enum boardioc_termtype_e
|
|
|
|
{
|
|
|
|
BOARDIOC_XTERM_RAW = 0, /* Raw NX terminal window */
|
|
|
|
BOARDIOC_XTERM_FRAMED, /* Framed NxTK terminal window */
|
2019-08-26 02:37:23 +02:00
|
|
|
BOARDIOC_XTERM_TOOLBAR /* Toolbar of framed NxTK terminal window */
|
2019-03-06 16:17:19 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
struct boardioc_nxterm_create_s
|
|
|
|
{
|
|
|
|
NXTERM nxterm; /* Returned NXTERM handle */
|
|
|
|
FAR void *hwnd; /* Window handle (NXWINDOW or NXTKWINDOW). */
|
|
|
|
struct nxterm_window_s wndo; /* Describes the initial window: color, size, font */
|
|
|
|
enum boardioc_termtype_e type; /* Terminal window type */
|
|
|
|
uint8_t minor; /* Terminal device minor number, N, in
|
|
|
|
* /dev/nxtermN. 0 <= N <= 255 */
|
|
|
|
};
|
2019-04-02 14:32:55 +02:00
|
|
|
|
2019-05-16 19:54:38 +02:00
|
|
|
struct boardioc_nxterm_ioctl_s
|
2019-03-06 22:21:29 +01:00
|
|
|
{
|
2019-11-06 02:39:36 +01:00
|
|
|
int cmd; /* IOCTL command */
|
|
|
|
uintptr_t arg; /* IOCTL argument */
|
2019-03-06 22:21:29 +01:00
|
|
|
};
|
2019-03-06 16:17:19 +01:00
|
|
|
#endif /* CONFIG_NXTERM */
|
|
|
|
|
2021-07-24 00:31:37 +02:00
|
|
|
#ifdef CONFIG_BOARDCTL_BOOT_IMAGE
|
|
|
|
|
|
|
|
/* Structure containing the arguments to the BOARDIOC_BOOT_IMAGE command */
|
|
|
|
|
|
|
|
struct boardioc_boot_info_s
|
|
|
|
{
|
|
|
|
FAR const char *path; /* Path to application firmware image */
|
|
|
|
uint32_t header_size; /* Size of the image header in bytes */
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2023-04-04 10:45:56 +02:00
|
|
|
#if defined(CONFIG_BOARDCTL_RESET) || defined(CONFIG_BOARDCTL_RESET_CAUSE)
|
2022-03-30 05:50:19 +02:00
|
|
|
/* Describes the reason of last reset */
|
|
|
|
|
|
|
|
enum boardioc_reset_cause_e
|
|
|
|
{
|
|
|
|
BOARDIOC_RESETCAUSE_NONE = 0,
|
|
|
|
BOARDIOC_RESETCAUSE_SYS_CHIPPOR, /* chip power on */
|
|
|
|
BOARDIOC_RESETCAUSE_SYS_RWDT, /* RTC watchdog system reset */
|
|
|
|
BOARDIOC_RESETCAUSE_SYS_BOR, /* brown-out system reset */
|
|
|
|
BOARDIOC_RESETCAUSE_CORE_SOFT, /* software core reset */
|
|
|
|
BOARDIOC_RESETCAUSE_CORE_DPSP, /* deep-sleep core reset */
|
|
|
|
BOARDIOC_RESETCAUSE_CORE_MWDT, /* main watchdog core reset */
|
|
|
|
BOARDIOC_RESETCAUSE_CORE_RWDT, /* RTC watchdog core reset */
|
|
|
|
BOARDIOC_RESETCAUSE_CPU_MWDT, /* main watchdog cpu reset */
|
|
|
|
BOARDIOC_RESETCAUSE_CPU_SOFT, /* software cpu reset */
|
2022-11-13 20:43:11 +01:00
|
|
|
BOARDIOC_RESETCAUSE_CPU_RWDT, /* RTC watchdog cpu reset */
|
|
|
|
BOARDIOC_RESETCAUSE_PIN, /* Pin reset */
|
|
|
|
BOARDIOC_RESETCAUSE_LOWPOWER, /* Low power reset */
|
|
|
|
BOARDIOC_RESETCAUSE_UNKOWN /* Unknown reset cause */
|
2022-03-30 05:50:19 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
enum boardioc_softreset_subreason_e
|
|
|
|
{
|
|
|
|
BOARDIOC_SOFTRESETCAUSE_USER_REBOOT = 0,
|
2023-04-03 20:39:00 +02:00
|
|
|
BOARDIOC_SOFTRESETCAUSE_ASSERT,
|
|
|
|
BOARDIOC_SOFTRESETCAUSE_PANIC,
|
2023-04-01 13:21:38 +02:00
|
|
|
BOARDIOC_SOFTRESETCAUSE_ENTER_BOOTLOADER,
|
2022-06-21 06:39:14 +02:00
|
|
|
BOARDIOC_SOFTRESETCAUSE_ENTER_RECOVERY,
|
2023-03-02 04:21:14 +01:00
|
|
|
BOARDIOC_SOFTRESETCAUSE_RESTORE_FACTORY,
|
|
|
|
BOARDIOC_SOFTRESETCAUSE_RESTORE_FACTORY_INQUIRY
|
2022-03-30 05:50:19 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct boardioc_reset_cause_s
|
|
|
|
{
|
|
|
|
enum boardioc_reset_cause_e cause; /* The reason of last reset */
|
|
|
|
uint32_t flag; /* watchdog number when watchdog reset,
|
|
|
|
* or soft-reset subreason */
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2016-06-05 20:13:56 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* Public Data
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
#undef EXTERN
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
#define EXTERN extern "C"
|
|
|
|
extern "C"
|
|
|
|
{
|
|
|
|
#else
|
|
|
|
#define EXTERN extern
|
|
|
|
#endif
|
|
|
|
|
2015-03-31 19:25:52 +02:00
|
|
|
/****************************************************************************
|
|
|
|
* 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.
|
|
|
|
*
|
2021-02-03 09:42:38 +01:00
|
|
|
* 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.
|
2015-03-31 19:25:52 +02:00
|
|
|
*
|
|
|
|
* 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
|
2019-09-29 20:52:20 +02:00
|
|
|
* with the errno variable set to indicate the nature of the failure.
|
2015-03-31 19:25:52 +02:00
|
|
|
*
|
|
|
|
****************************************************************************/
|
|
|
|
|
|
|
|
int boardctl(unsigned int cmd, uintptr_t arg);
|
|
|
|
|
2016-06-05 20:13:56 +02:00
|
|
|
#undef EXTERN
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2021-08-01 09:00:54 +02:00
|
|
|
#endif /* CONFIG_BOARDCTL */
|
2015-03-31 19:25:52 +02:00
|
|
|
#endif /* __INCLUDE_SYS_BOARDCTL_H */
|