OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity
incubator-nuttx/include/nuttx/fs/ioctl.h

317 lines
15 KiB
C
Raw Blame History

/****************************************************************************
* include/nuttx/fs/ioctl.h
*
* Copyright (C) 2008, 2009, 2011-2014 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_NUTTX_FS_IOCTL_H
#define __INCLUDE_NUTTX_FS_IOCTL_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* General ioctl definitions ************************************************/
/* Each NuttX ioctl commands are uint16_t's consisting of an 8-bit type
* identifier and an 8-bit command number. All comman type identifiers are
* defined below:
*/
#define _TIOCBASE (0x0100) /* Terminal I/O ioctl commands */
#define _WDIOCBASE (0x0200) /* Watchdog driver ioctl commands */
#define _FIOCBASE (0x0300) /* File system ioctl commands */
#define _DIOCBASE (0x0400) /* Character driver ioctl commands */
#define _BIOCBASE (0x0500) /* Block driver ioctl commands */
#define _MTDIOCBASE (0x0600) /* MTD ioctl commands */
#define _SIOCBASE (0x0700) /* Socket ioctl commands */
#define _ARPIOCBASE (0x0800) /* ARP ioctl commands */
#define _TSIOCBASE (0x0900) /* Touchscreen ioctl commands */
#define _SNIOCBASE (0x0a00) /* Sensor ioctl commands */
#define _ANIOCBASE (0x0b00) /* Analog (DAC/ADC) ioctl commands */
#define _PWMIOCBASE (0x0c00) /* PWM ioctl commands */
#define _CAIOCBASE (0x0d00) /* CDC/ACM ioctl commands */
#define _BATIOCBASE (0x0e00) /* Battery driver ioctl commands */
#define _QEIOCBASE (0x0f00) /* Quadrature encoder ioctl commands */
#define _AUDIOIOCBASE (0x1000) /* Audio ioctl commands */
#define _SLCDIOCBASE (0x1100) /* Segment LCD ioctl commands */
#define _WLIOCBASE (0x1200) /* Wireless modules ioctl commands */
#define _CFGDIOCBASE (0x1300) /* Config Data device (app config) ioctl commands */
#define _TCIOCBASE (0x1400) /* Timer ioctl commands */
/* Macros used to manage ioctl commands */
#define _IOC_MASK (0x00ff)
#define _IOC_TYPE(cmd) ((cmd)&~_IOC_MASK)
#define _IOC_NR(cmd) ((cmd)&_IOC_MASK)
#define _IOC(type,nr) ((type)|(nr))
/* Terminal I/O ioctl commands **********************************************/
#define _TIOCVALID(c) (_IOC_TYPE(c)==_TIOCBASE)
#define _TIOC(nr) _IOC(_TIOCBASE,nr)
/* Terminal I/O IOCTL definitions are retained in tioctl.h */
#include <nuttx/serial/tioctl.h>
/* Watchdog driver ioctl commands *******************************************/
#define _WDIOCVALID(c) (_IOC_TYPE(c)==_WDIOCBASE)
#define _WDIOC(nr) _IOC(_WDIOCBASE,nr)
/* Timer driver ioctl commands *******************************************/
#define _TCIOCVALID(c) (_IOC_TYPE(c)==_TCIOCBASE)
#define _TCIOC(nr) _IOC(_TCIOCBASE,nr)
/* NuttX file system ioctl definitions **************************************/
#define _FIOCVALID(c) (_IOC_TYPE(c)==_FIOCBASE)
#define _FIOC(nr) _IOC(_FIOCBASE,nr)
#define FIOC_MMAP _FIOC(0x0001) /* IN: Location to return address (void **)
* OUT: If media is directly acccesible,
* return (void*) base address
* of file
*/
#define FIOC_REFORMAT _FIOC(0x0002) /* IN: None
* OUT: None
*/
#define FIOC_OPTIMIZE _FIOC(0x0003) /* IN: None
* OUT: None
*/
#define FIOC_FILENAME _FIOC(0x0004) /* IN: FAR const char ** pointer
* OUT: Pointer to a persistent file name
* (Guaranteed to persist while the file
* is open).
*/
#define FIONREAD _FIOC(0x0005) /* IN: Location to return value (int *)
* OUT: Bytes readable from this fd
*/
#define FIONWRITE _FIOC(0x0006) /* IN: Location to return value (int *)
* OUT: Bytes writable to this fd
*/
/* NuttX file system ioctl definitions **************************************/
#define _DIOCVALID(c) (_IOC_TYPE(c)==_DIOCBASE)
#define _DIOC(nr) _IOC(_DIOCBASE,nr)
#define DIOC_GETPRIV _DIOC(0x0001) /* IN: Location to return handle (void **)
* OUT: Reference to internal data
* structure. May have a reference
* incremented.
*/
#define DIOC_RELPRIV _DIOC(0x0003) /* IN: None
* OUT: None, reference obtained by
* FIOC_GETPRIV released.
*/
#define DIOC_SETKEY _DIOC(0X0004) /* IN: Encryption key
* OUT: None
*/
/* NuttX block driver ioctl definitions *************************************/
#define _BIOCVALID(c) (_IOC_TYPE(c)==_BIOCBASE)
#define _BIOC(nr) _IOC(_BIOCBASE,nr)
#define BIOC_XIPBASE _BIOC(0x0001) /* Perform mapping to random access memory.
* IN: Pointer to pointer to void in
* which to received the XIP base.
* OUT: If media is directly acccesible,
* return (void*) base address
* of device memory */
#define BIOC_PROBE _BIOC(0x0002) /* Re-probe and interface; check for media
* in the slot
* IN: None
* OUT: None (ioctl return value provides
* success/failure indication). */
#define BIOC_EJECT _BIOC(0x0003) /* Eject/disable media in the slot
* IN: None
* OUT: None (ioctl return value provides
* success/failure indication). */
#define BIOC_LLFORMAT _BIOC(0x0004) /* Low-Level Format on SMART flash devices
* IN: None
* OUT: None (ioctl return value provides
* success/failure indication). */
#define BIOC_GETFORMAT _BIOC(0x0005) /* Returns SMART flash format information
* such as format status, logical sector
* size, total sectors, free sectors, etc.
* IN: None
* OUT: Pointer to the format information. */
#define BIOC_ALLOCSECT _BIOC(0x0006) /* Allocate a logical sector from the block
* device.
* IN: None
* OUT: Logical sector number allocated. */
#define BIOC_FREESECT _BIOC(0x0007) /* Allocate a logical sector from the block
* device.
* IN: None
* OUT: Logical sector number allocated. */
#define BIOC_READSECT _BIOC(0x0008) /* Read a logical sector from the block
* device.
* IN: Pointer to sector read data (the
* logical sector number, count and
* read buffer address
* OUT: Number of bytes read or error */
#define BIOC_WRITESECT _BIOC(0x0009) /* Write to data to a logical sector
* IN: Pointer to sector write data (the
* logical secor number and write
* buffer address
* OUT: None (ioctl return value provides
* success/failure indication). */
#define BIOC_GETPROCFSD _BIOC(0x000A) /* Get ProcFS data specific to the
* block device.
* IN: Pointer to a struct defined for
* the block to load with it's
* ProcFS data.
* OUT: None (ioctl return value provides
* success/failure indication). */
/* NuttX MTD driver ioctl definitions ***************************************/
#define _MTDIOCVALID(c) (_IOC_TYPE(c)==_MTDIOCBASE)
#define _MTDIOC(nr) _IOC(_MTDIOCBASE,nr)
#define MTDIOC_GEOMETRY _MTDIOC(0x0001) /* IN: Pointer to write-able struct
* mtd_geometry_s in which to receive
* receive geometry data (see mtd.h)
* OUT: Geometry structure is populated
* with data for the MTD */
#define MTDIOC_XIPBASE _MTDIOC(0x0002) /* IN: Pointer to pointer to void in
* which to received the XIP base.
* OUT: If media is directly acccesible,
* return (void*) base address
* of device memory */
#define MTDIOC_BULKERASE _MTDIOC(0x0003) /* IN: None
* OUT: None */
/* NuttX ARP driver ioctl definitions (see netinet/arp.h) *******************/
#define _ARPIOCVALID(c) (_IOC_TYPE(c)==_ARPIOCBASE)
#define _ARPIOC(nr) _IOC(_ARPIOCBASE,nr)
/* NuttX touchscreen ioctl definitions (see nuttx/input/touchscreen.h) ******/
#define _TSIOCVALID(c) (_IOC_TYPE(c)==_TSIOCBASE)
#define _TSIOC(nr) _IOC(_TSIOCBASE,nr)
/* NuttX sensor ioctl definitions (see nuttx/sensor/xxx.h) ******************/
#define _SNIOCVALID(c) (_IOC_TYPE(c)==_SNIOCBASE)
#define _SNIOC(nr) _IOC(_SNIOCBASE,nr)
/* Nuttx Analog (DAC/ADC_ ioctl commands ************************************/
#define _ANIOCVALID(c) (_IOC_TYPE(c)==_ANIOCBASE)
#define _ANIOC(nr) _IOC(_ANIOCBASE,nr)
#define ANIOC_TRIGGER _ANIOC(0x0001) /* Trigger one conversion
* IN: None
* OUT: None */
/* NuttX PWM ioctl definitions (see nuttx/pwm.h) ****************************/
#define _PWMIOCVALID(c) (_IOC_TYPE(c)==_PWMIOCBASE)
#define _PWMIOC(nr) _IOC(_PWMIOCBASE,nr)
/* NuttX USB CDC/ACM serial driver ioctl definitions ************************/
/* (see nuttx/usb/cdcacm.h) */
#define _CAIOCVALID(c) (_IOC_TYPE(c)==_CAIOCBASE)
#define _CAIOC(nr) _IOC(_CAIOCBASE,nr)
/* NuttX USB CDC/ACM serial driver ioctl definitions ************************/
/* (see nuttx/power/battery.h) */
#define _BATIOCVALID(c) (_IOC_TYPE(c)==_BATIOCBASE)
#define _BATIOC(nr) _IOC(_BATIOCBASE,nr)
/* NuttX Quadrature Encoder driver ioctl definitions ************************/
/* (see nuttx/power/battery.h) */
#define _QEIOCVALID(c) (_IOC_TYPE(c)==_QEIOCBASE)
#define _QEIOC(nr) _IOC(_QEIOCBASE,nr)
/* NuttX Audio driver ioctl definitions *************************************/
/* (see nuttx/audio/audio.h) */
#define _AUDIOIOCVALID(c) (_IOC_TYPE(c)==_AUDIOIOCBASE)
#define _AUDIOIOC(nr) _IOC(_AUDIOIOCBASE,nr)
/* Segment LCD driver ioctl definitions *************************************/
/* (see nuttx/include/lcd/slcd_codec.h */
#define _SLCDIOCVALID(c) (_IOC_TYPE(c)==_SLCDIOCBASE)
#define _SLCDIOC(nr) _IOC(_SLCDIOCBASE,nr)
/* Wireless driver ioctl definitions ****************************************/
/* (see nuttx/include/wireless/wireless.h */
#define _WLIOCVALID(c) (_IOC_TYPE(c)==_WLIOCBASE)
#define _WLIOC(nr) _IOC(_WLIOCBASE,nr)
/* Application Config Data driver ioctl definitions *************************/
/* (see nuttx/include/configdata.h */
#define _CFGDIOCVALID(c) (_IOC_TYPE(c)==_CFGDIOCBASE)
#define _CFGDIOC(nr) _IOC(_CFGDIOCBASE,nr)
/****************************************************************************
* Public Type Definitions
****************************************************************************/
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_NUTTX_FS_IOCTL_H */
Reference in New Issue View Git Blame Copy Permalink