nuttx/include/sys/boardctl.h

532 lines
20 KiB
C
Raw Normal View History

/****************************************************************************
* include/sys/boardctl.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 __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_PM
# include <nuttx/power/pm.h>
#endif
#ifdef CONFIG_VNCSERVER
# include <nuttx/nx/nx.h>
#endif
#ifdef CONFIG_NXTERM
# include <nuttx/nx/nxterm.h>
#endif
#ifdef CONFIG_BOARDCTL_SPINLOCK
# include <nuttx/spinlock.h>
#endif
#ifdef CONFIG_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
2019-08-21 17:32:59 +02:00
* initialization logic and the matching application logic.
* The value could 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_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_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
*
* 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_MKRD
* DESCRIPTION: Create a RAM disk
* ARG: Pointer to read-only instance of struct boardioc_mkrd_s.
* CONFIGURATION: CONFIG_BOARDCTL_MKRD
* DEPENDENCIES: None
*
* CMD: BOARDIOC_ROMDISK
2021-03-25 17:16:42 +01:00
* DESCRIPTION: Register a ROM disk
* ARG: Pointer to read-only instance of struct boardioc_romdisk_s.
* CONFIGURATION: CONFIG_BOARDCTL_ROMDISK
* DEPENDENCIES: None
*
* 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_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
* CONFIG_BUILD_PROTECTED is also selected.
* 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_BOARDCTL && CONFIG_BOARDCTL_USBDEVCTRL
* DEPENDENCIES: Board logic must provide board_<usbdev>_initialize()
*
* CMD: BOARDIOC_NX_START
* DESCRIPTION: Start the NX server
* ARG: Integer display number to be served by this NXMU instance.
* CONFIGURATION: CONFIG_NX
* DEPENDENCIES: Base graphics logic provides nxmu_start()
*
* 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
* DEPENDENCIES: VNC server provides nx_vnc_fbinitialize()
*
* 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()
*
* 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
* CONFIGURATION: CONFIG_NXTERM
* DEPENDENCIES: Base NX terminal logic provides nxterm_ioctl_tap()
*
* 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
*
* 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.
*/
#define BOARDIOC_INIT _BOARDIOC(0x0001)
#define BOARDIOC_FINALINIT _BOARDIOC(0x0002)
#define BOARDIOC_POWEROFF _BOARDIOC(0x0003)
#define BOARDIOC_RESET _BOARDIOC(0x0004)
#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)
#define BOARDIOC_SPINLOCK _BOARDIOC(0x0011)
#define BOARDIOC_UNIQUEKEY _BOARDIOC(0x0012)
#define BOARDIOC_SWITCH_BOOT _BOARDIOC(0x0013)
#define BOARDIOC_BOOT_IMAGE _BOARDIOC(0x0014)
#define BOARDIOC_RESET_CAUSE _BOARDIOC(0x0015)
#define BOARDIOC_IRQ_AFFINITY _BOARDIOC(0x0016)
/* 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(0x0017)
/****************************************************************************
* Public Type Definitions
****************************************************************************/
/* Structures used with IOCTL commands */
#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,
BOARDIOC_PM_QUERYSTATE,
BOARDIOC_PM_CHANGESTATE,
BOARDIOC_PM_CHECKSTATE
};
struct boardioc_pm_ctrl_s
{
uint32_t action;
uint32_t domain;
uint32_t state;
uint32_t count;
uint32_t priority;
};
#endif
#ifdef CONFIG_BOARDCTL_MKRD
/* 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
#ifdef CONFIG_BOARDCTL_ROMDISK
/* 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.
*/
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
#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
/* 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 const struct symtab_s *symtab;
int nsymbols;
};
#ifdef CONFIG_BUILTIN
/* Arguments passed with the BOARDIOC_BUILTIN command */
struct builtin_s; /* Forward reference */
struct boardioc_builtin_s
{
FAR const struct builtin_s *builtins;
int count;
};
#endif
#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 identified by the 'inst' field of the structure.
*
* enum boardioc_usbdev_action_e: Identifies the action to perform 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_USBADB
, BOARDIOC_USBDEV_ADB /* ADB */
, BOARDIOC_USBDEV_FASTBOOT = BOARDIOC_USBDEV_ADB
#endif
#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 */
Squashed commit of the following: commit 69fcf3e849dbcc8cbab4310d587a215ddd0a7382 Author: Alan Carvalho de Assis <acassis@gmail.com> Date: Sun Jul 16 08:39:33 2017 -0600 Fix spark/stm32_composite.c: board_composite_connect cannot be static commit 28eb2534013397911a30c4014f09167f66be9f32 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sun Jul 16 08:36:01 2017 -0600 Composite: Final review for coding style before merge commit e6af1b9994ff9eb371f72be810f2e0377651fc10 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sun Jul 16 07:41:38 2017 -0600 Composite: Simplify some intiialization of data structures. commit 771c367411b8efb1e6269a9863ad37966f0c6660 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sun Jul 16 07:15:08 2017 -0600 Cosmetic changes to alignment. commit 5d67ddda4e4c0916830e8bda03cad5dc795724b3 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sun Jul 16 07:00:48 2017 -0600 USBMSC: Add missing logic to saved device description. commit 0729151d29a440cae4fc0e019567020417026c03 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 17:11:41 2017 -0600 Trivial, costmetic commit 74b916ff84ba50cb7e6b7493efffe56017064136 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 14:50:29 2017 -0600 Composite: Private functions need to be marked static. Move static functions out of 'Public Functions' to 'Private Functions' where they belong. Disable composite configuration 1 in all STM32 F1 configurations. commit cfaa4ece13adc37cf1a1316a69d885e63e7bc2de Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 13:20:34 2017 -0600 Add some comments. commit 8143563be6ca1c41b1dd5aaed24cf9a22e262cac Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 12:33:10 2017 -0600 Spark: Need to condition out MSC logic in composite setup if there is no MSC in the composite. commit 69d3a91ef10a1c16aeb943b49b572ee479a267ad Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 11:03:33 2017 -0600 Composite: Remove all dependencies on CONFIG_SYSTEM_COMPOSITE_* configuration settings. Nothing in the OS can depend on external application settings. commit 55a4388bbd78101249fc87bb9137438aed9dd3f2 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 09:59:31 2017 -0600 All composite configurations now also support a dual CDC/ACM configuration. commit 428f2147af15142f6a02b3d86d3635bd5dbe3f2a Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 09:24:32 2017 -0600 Composite: Move board_msc* interfaces from apps/system/composite to the board specific OS logic where they belong. commit f1cc168a5c0785d3716c6106f1d5f1e24db2c4c0 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 08:56:33 2017 -0600 Refresh all composite configurations. commit 246afcaa109b0bfa3e72281b367455a59f9266cd Merge: 919877191d 02c6672868 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 08:22:26 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 919877191d62d76e859f143f0784c53cc362adb3 Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jul 15 08:20:02 2017 -0600 Composite setup: Remove useless board_cdc* wrapper. commit 82129cf8c68816ec34cae9801cd3582ca63ece0a Merge: f2cb8b252a 6537e4ea20 Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jul 14 16:23:57 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit f2cb8b252a60acc4757dd0be5ea8e649f4f5b09f Author: Alan Carvalho de Assis <acassis@gmail.com> Date: Fri Jul 14 10:19:35 2017 -0600 Composite: Fix for another cloned typo. commit 676cfd526a65d7edb2fe10f07c5e2e2332321a5f Author: Alan Carvalho de Assis <acassis@gmail.com> Date: Fri Jul 14 09:11:37 2017 -0600 Composite: Fix some typos commit 1ea0368c185a8b917190ff9fff5142fc844c75de Author: Alan Carvalho de Assis <acassis@gmail.com> Date: Fri Jul 14 09:10:18 2017 -0600 Composite: ./stm3210e-eval/src/stm32_composite.c commit e485caced9d7910965795c5cd2e4b823a2b4551d Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jul 14 09:08:17 2017 -0600 Composite: I don't think the original code should have forced minor=0. commit 6443c296219037cf6e54ab6758d3b66081628e7a Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jul 14 07:15:38 2017 -0600 Composite: Flesh out support for all of other configurations that support composite. commit 23cbc28b053f1a237a47766cd5f5a282da80dda5 Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jul 14 06:59:45 2017 -0600 Detangle use of board_xyzclassobject() and board_xyzuninitialize() commit 1674cb8c8e16831a4984d32d06a232419ecde974 Merge: 6bc881a192 5033a6def7 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jul 13 13:57:40 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 6bc881a19296ed909ba4a03f420160864c79a55f Merge: fe3af4941d 85b8d16d8c Author: Gregory Nutt <gnutt@nuttx.org> Date: Tue Jul 11 12:24:07 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit fe3af4941d667d3e6cee74d1138d5f6c00401c0e Merge: 0f9ad16e18 1bc0eea143 Author: Gregory Nutt <gnutt@nuttx.org> Date: Mon Jul 10 11:07:36 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 0f9ad16e1841677177819c498d9d554bba9ecf12 Merge: a4cd90d4ef aa2e9c15a5 Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jul 7 20:26:53 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit a4cd90d4efa5a610b8fcdeb61d2cd3825d17471e Merge: 8a4be7175e 31f832d8c5 Author: Gregory Nutt <gnutt@nuttx.org> Date: Wed Jul 5 11:12:52 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 8a4be7175e2f1d25edf85860c8b4ba74a8715829 Merge: 18a32ed2ca ae1771454a Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jun 30 16:14:04 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 18a32ed2cadbfe0951fda93866cb44c4713b6255 Merge: aaa81ce497 6d8df90b79 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 29 10:18:16 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit aaa81ce497aaa566e01e6b5a242e1a098936490e Merge: 4eb548226b 8cb4636bb1 Author: Gregory Nutt <gnutt@nuttx.org> Date: Mon Jun 26 11:56:11 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 4eb548226b51778485ccc3e23790cfcaa30110ee Merge: 2327f5a1b4 dc8eec0b61 Author: Gregory Nutt <gnutt@nuttx.org> Date: Mon Jun 19 17:27:00 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 2327f5a1b4f66c7ecc86bcd66ee3490eaa060ed0 Merge: 49cd279fc6 99bf0b522b Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jun 16 17:30:03 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 49cd279fc6a5efc2029681469d315fa82ea7db1c Merge: bb6a13f30a 46f86982ee Author: Gregory Nutt <gnutt@nuttx.org> Date: Wed Jun 14 09:17:49 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit bb6a13f30a262b814299c4f8ec146d4a69a1c093 Merge: 918480047a ac93d4bda9 Author: Gregory Nutt <gnutt@nuttx.org> Date: Mon Jun 5 17:40:06 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 918480047afd324eddcfa7680cedbe7d90f4c064 Merge: e4d262436c 4526cd665e Author: Gregory Nutt <gnutt@nuttx.org> Date: Sat Jun 3 08:52:31 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit e4d262436c0594560d0feddb1413fdcf863ec258 Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jun 2 07:19:27 2017 -0600 SAMV71-Xult Composite: Now can switch between two different composite configurations dynamically. commit 815257743d88220ead9113c8238fb9d3e47549ca Author: Gregory Nutt <gnutt@nuttx.org> Date: Fri Jun 2 07:11:57 2017 -0600 usbdev composite and SAMV7-Xult: Move board-specific USB composite configuration out of boardctl.c and into board-specific logic where it belongs. Add a configuration option to the boardctl() calls to support multiple composite device configurations dynamically. commit ac13619dc5d99ecf2f7feb76e343a1889bafafc9 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 17:03:58 2017 -0600 Cosmetic commit 9dd41bdd2f63d33b1bd3dee6d6c3364fc0f04009 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 17:02:43 2017 -0600 Composite: More compile-related fixes commit fc1438c95d72ec5aa9252611548fb0e43c857ade Merge: 049ccbfcbe ff2b54a5e0 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 16:35:41 2017 -0600 Merge remote-tracking branch 'origin/master' into composite commit 049ccbfcbeefd1de3c61fd56bb963cb877ffdea3 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 16:35:16 2017 -0600 Composite: Add some structure definitions missed in first application of the patch. commit ef33329e3a97dbed2cb98bc21df8e3b9fdb561ac Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 16:14:46 2017 -0600 Add a warning commit 89f77cd91aec238e02a39aad2af916db4c5b0990 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 16:11:27 2017 -0600 Fix some incomplete name changes commit 0bb7af549a74743ec2a5e9d6fd0872d8dea92dc4 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 15:09:50 2017 -0600 It is unnecessary to pack a structure that consists only of uint8_t data fields. commit bd9b548914c22179b56e0eaba4faa8ff0ac17b37 Author: Gregory Nutt <gnutt@nuttx.org> Date: Thu Jun 1 15:05:41 2017 -0600 Remove COMPILE_TIME_ASSERTION commit 7e6f481581d79f02499905c9eb79e4b6bc3835aa Author: Frank Benkert <Frank.Benkert@avat.de> Date: Thu Jun 1 14:58:04 2017 -0600 Part II of the same big commit commit dcc9b07715cc6996c6495cddef5fd7dc5a3d861e Author: Frank Benkert <Frank.Benkert@avat.de> Date: Thu Jun 1 14:08:22 2017 -0600 [[This is part 1 or several commits]] We developed a huge Changeset over a year ago to make USB Composite configuration dynamical and be able to instanciate the CDCACM multiple times inside this device. We use this feature to switch between one in normal and up to three CDCACMs in maintenance boot. The control path starts in “boardctl.c” where the configuration for the device is constructed. There are still a few issues which I’ll ask you to have a look at before this beast can be merged. 1. To be able to construct the data dynamically I have changed some USB-Structs to be packed. Maybe there are additional structs to change (just for completeness – not for current functionality). 2. I’ve added the Macro “COMPILE_TIME_ASSERTION” two times (in usbmsc_desc.c and in cdcacm_desc.c) to stay private. Maybe you’ll find a better place. It’s used to check the size of the structs against the assumptions. 3. I’ve changed the interface for some USB-Functions to receive also the dynamic configuration. Maybe this can be done more elegant. 4. The original NuttX (without the patch) seems to have problems with a Composite device holding a CDCACM and an MSC. The “USB SET CONFIGURATION” request does not to work at all. This makes the test fail under Windows and under Linux. Applying this patch doesn’t change anything – because it only changes the configuration – not the behavior. Maybe you’ll have a look at this problem before applying the patch.
2017-07-16 16:43:17 +02:00
uint8_t config; /* Configuration used with BOARDIOC_USBDEV_CONNECT */
FAR void **handle; /* Connection handle */
};
#endif /* CONFIG_BOARDCTL_USBDEVCTRL */
#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
#ifdef CONFIG_NXTERM
/* Arguments passed with the BOARDIOC_NXTERM command */
enum boardioc_termtype_e
{
BOARDIOC_XTERM_RAW = 0, /* Raw NX terminal window */
BOARDIOC_XTERM_FRAMED, /* Framed NxTK terminal window */
BOARDIOC_XTERM_TOOLBAR /* Toolbar of framed NxTK terminal window */
};
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 */
};
struct boardioc_nxterm_ioctl_s
{
2019-11-06 02:39:36 +01:00
int cmd; /* IOCTL command */
uintptr_t arg; /* IOCTL argument */
};
#endif /* CONFIG_NXTERM */
#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
#if defined(CONFIG_BOARDCTL_RESET) || defined(CONFIG_BOARDCTL_RESET_CAUSE)
/* 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 */
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 */
};
enum boardioc_softreset_subreason_e
{
BOARDIOC_SOFTRESETCAUSE_USER_REBOOT = 0,
BOARDIOC_SOFTRESETCAUSE_ASSERT,
BOARDIOC_SOFTRESETCAUSE_PANIC,
BOARDIOC_SOFTRESETCAUSE_ENTER_BOOTLOADER,
BOARDIOC_SOFTRESETCAUSE_ENTER_RECOVERY,
BOARDIOC_SOFTRESETCAUSE_RESTORE_FACTORY,
BOARDIOC_SOFTRESETCAUSE_RESTORE_FACTORY_INQUIRY
};
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
/****************************************************************************
* 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
2019-09-29 20:52:20 +02:00
* with the errno variable set to indicate the nature of the failure.
*
****************************************************************************/
int boardctl(unsigned int cmd, uintptr_t arg);
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* CONFIG_BOARDCTL */
#endif /* __INCLUDE_SYS_BOARDCTL_H */