Update or add comments to files and functions for use by Doxygen.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12090 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -4,7 +4,7 @@
|
||||
This program and the accompanying materials are licensed and made
|
||||
available under the terms and conditions of the BSD License that
|
||||
accompanies this distribution. The full text of the license may be found at
|
||||
http://opensource.org/licenses/bsd-license.php.
|
||||
http://opensource.org/licenses/bsd-license.
|
||||
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
@@ -48,82 +48,59 @@
|
||||
#define _SYS_STAT_H_
|
||||
|
||||
#include <sys/featuretest.h>
|
||||
#include <sys/types.h> /* XXX */
|
||||
#include <sys/types.h>
|
||||
#include <sys/time.h>
|
||||
|
||||
struct stat {
|
||||
off_t st_size; /* file size, in bytes */
|
||||
off_t st_physsize; /* physical space the file consumes */
|
||||
off_t st_curpos; /* current position within the file, or XY coord. for Console */
|
||||
dtime_t st_birthtime; /* time of creation */
|
||||
dtime_t st_atime; /* time of last access */
|
||||
dtime_t st_mtime; /* time of last data modification */
|
||||
mode_t st_mode; /* file attributes */
|
||||
off_t st_size; ///< file size, in bytes
|
||||
off_t st_physsize; ///< physical space the file consumes
|
||||
off_t st_curpos; ///< current position within the file, or XY coord. for Console
|
||||
dtime_t st_birthtime; ///< time of creation
|
||||
dtime_t st_atime; ///< time of last access
|
||||
dtime_t st_mtime; ///< time of last data modification
|
||||
mode_t st_mode; ///< file attributes
|
||||
|
||||
blksize_t st_blksize; /* optimal blocksize for I/O */
|
||||
#if 0
|
||||
uint32_t st_flags; /* user defined flags for file */
|
||||
blkcnt_t st_blocks; /* blocks allocated for file */
|
||||
ino_t st_ino; /* inode's number */
|
||||
time_t st_ctime; /* time of last file status change */
|
||||
nlink_t st_nlink; /* number of hard links */
|
||||
uid_t st_uid; /* user ID of the file's owner */
|
||||
gid_t st_gid; /* group ID of the file's group */
|
||||
dev_t st_dev; /* inode's device */
|
||||
dev_t st_rdev; /* device type */
|
||||
uint32_t st_gen; /* file generation number */
|
||||
#endif
|
||||
blksize_t st_blksize; ///< optimal blocksize for I/O
|
||||
uint32_t st_spare[1];
|
||||
};
|
||||
|
||||
#if 0
|
||||
#define st_atime st_atimespec.tv_sec
|
||||
#define st_atimensec st_atimespec.tv_nsec
|
||||
#define st_mtime st_mtimespec.tv_sec
|
||||
#define st_mtimensec st_mtimespec.tv_nsec
|
||||
#define st_ctime st_ctimespec.tv_sec
|
||||
#define st_ctimensec st_ctimespec.tv_nsec
|
||||
#define st_birthtime st_birthtimespec.tv_sec
|
||||
#define st_birthtimensec st_birthtimespec.tv_nsec
|
||||
#endif
|
||||
#define S_ISUID 0004000 ///< set user id on execution
|
||||
#define S_ISGID 0002000 ///< set group id on execution
|
||||
#define S_ISTXT 0001000 ///< sticky bit
|
||||
|
||||
#define S_ISUID 0004000 /* set user id on execution */
|
||||
#define S_ISGID 0002000 /* set group id on execution */
|
||||
#define S_ISTXT 0001000 /* sticky bit */
|
||||
|
||||
#define S_IRWXU 0000700 /* RWX mask for owner */
|
||||
#define S_IRUSR 0000400 /* R for owner */
|
||||
#define S_IWUSR 0000200 /* W for owner */
|
||||
#define S_IXUSR 0000100 /* X for owner */
|
||||
#define S_IRWXU 0000700 ///< RWX mask for owner
|
||||
#define S_IRUSR 0000400 ///< R for owner
|
||||
#define S_IWUSR 0000200 ///< W for owner
|
||||
#define S_IXUSR 0000100 ///< X for owner
|
||||
|
||||
#define S_IREAD S_IRUSR
|
||||
#define S_IWRITE S_IWUSR
|
||||
#define S_IEXEC S_IXUSR
|
||||
|
||||
#define S_IRWXG 0000070 /* RWX mask for group */
|
||||
#define S_IRGRP 0000040 /* R for group */
|
||||
#define S_IWGRP 0000020 /* W for group */
|
||||
#define S_IXGRP 0000010 /* X for group */
|
||||
#define S_IRWXG 0000070 ///< RWX mask for group
|
||||
#define S_IRGRP 0000040 ///< R for group
|
||||
#define S_IWGRP 0000020 ///< W for group
|
||||
#define S_IXGRP 0000010 ///< X for group
|
||||
|
||||
#define S_IRWXO 0000007 /* RWX mask for other */
|
||||
#define S_IROTH 0000004 /* R for other */
|
||||
#define S_IWOTH 0000002 /* W for other */
|
||||
#define S_IXOTH 0000001 /* X for other */
|
||||
#define S_IRWXO 0000007 ///< RWX mask for other
|
||||
#define S_IROTH 0000004 ///< R for other
|
||||
#define S_IWOTH 0000002 ///< W for other
|
||||
#define S_IXOTH 0000001 ///< X for other
|
||||
|
||||
/* The Octal access modes, above, fall into the Hex mask 0x00000FFF.
|
||||
Traditionally, the remainder of the flags are specified in Octal
|
||||
but they are expressed in Hex here for modern clarity.
|
||||
*/
|
||||
#define _S_IFMT 0x000FF000 /* type-of-file mask */
|
||||
#define _S_IFIFO 0x00001000 /* named pipe (fifo) */
|
||||
#define _S_IFCHR 0x00002000 /* character special */
|
||||
#define _S_IFDIR 0x00004000 /* directory */
|
||||
#define _S_IFBLK 0x00006000 /* block special */
|
||||
#define _S_IFREG 0x00008000 /* regular */
|
||||
#define _S_IFSOCK 0x0000C000 /* socket */
|
||||
#define _S_ITTY 0x00010000 /* File connects to a TTY device */
|
||||
#define _S_IWTTY 0x00020000 /* TTY receives Wide characters */
|
||||
#define _S_ICONSOLE 0x00030000 /* UEFI Console Device */
|
||||
#define _S_IFMT 0x000FF000 ///< type-of-file mask
|
||||
#define _S_IFIFO 0x00001000 ///< named pipe (fifo)
|
||||
#define _S_IFCHR 0x00002000 ///< character special
|
||||
#define _S_IFDIR 0x00004000 ///< directory
|
||||
#define _S_IFBLK 0x00006000 ///< block special
|
||||
#define _S_IFREG 0x00008000 ///< regular
|
||||
#define _S_IFSOCK 0x0000C000 ///< socket
|
||||
#define _S_ITTY 0x00010000 ///< File connects to a TTY device
|
||||
#define _S_IWTTY 0x00020000 ///< TTY receives Wide characters
|
||||
#define _S_ICONSOLE 0x00030000 ///< UEFI Console Device
|
||||
|
||||
/* UEFI specific (FAT file system) File attributes.
|
||||
Specified in Hexadecimal instead of Octal.
|
||||
@@ -134,71 +111,56 @@ struct stat {
|
||||
#define S_ISYSTEM 0x00400000 // System File
|
||||
#define S_IDIRECTORY 0x01000000 // Directory
|
||||
#define S_IARCHIVE 0x02000000 // Archive Bit
|
||||
#define S_IROFS 0x08000000 /* Read Only File System */
|
||||
#define S_IROFS 0x08000000 ///< Read Only File System
|
||||
|
||||
#define S_EFIONLY 0xF0000000 /* Flags only used by the EFI system calls. */
|
||||
#define S_EFIONLY 0xF0000000 ///< Flags only used by the EFI system calls.
|
||||
|
||||
#define S_EFISHIFT 20 // LS bit of the UEFI attributes
|
||||
|
||||
//#define _S_IFLNK 0120000 /* symbolic link */
|
||||
//#define _S_IFWHT 0160000 /* whiteout */
|
||||
//#define _S_ARCH1 0200000 /* Archive state 1, ls -l shows 'a' */
|
||||
//#define _S_ARCH2 0400000 /* Archive state 2, ls -l shows 'A' */
|
||||
//#define _S_ISVTX 0001000 /* ???? save swapped text even after use */
|
||||
|
||||
|
||||
#define S_IFMT _S_IFMT
|
||||
#define S_IFBLK _S_IFBLK
|
||||
#define S_IFREG _S_IFREG
|
||||
#define S_IFIFO _S_IFIFO
|
||||
#define S_IFCHR _S_IFCHR
|
||||
#define S_IFDIR _S_IFDIR
|
||||
//#define S_IFLNK _S_IFLNK
|
||||
//#define S_ISVTX _S_ISVTX
|
||||
#define S_IFSOCK _S_IFSOCK
|
||||
//#define S_IFWHT _S_IFWHT
|
||||
|
||||
//#define S_ARCH1 _S_ARCH1
|
||||
//#define S_ARCH2 _S_ARCH2
|
||||
#define S_ISDIR(m) ((m & _S_IFMT) == _S_IFDIR) ///< directory
|
||||
#define S_ISCHR(m) ((m & _S_IFMT) == _S_IFCHR) ///< char special
|
||||
#define S_ISREG(m) ((m & _S_IFMT) == _S_IFREG) ///< regular file
|
||||
#define S_ISBLK(m) ((m & _S_IFMT) == _S_IFBLK) ///< block special
|
||||
#define S_ISSOCK(m) ((m & _S_IFMT) == _S_IFSOCK) ///< socket
|
||||
|
||||
#define S_ISDIR(m) ((m & _S_IFMT) == _S_IFDIR) /* directory */
|
||||
#define S_ISCHR(m) ((m & _S_IFMT) == _S_IFCHR) /* char special */
|
||||
#define S_ISREG(m) ((m & _S_IFMT) == _S_IFREG) /* regular file */
|
||||
#define S_ISBLK(m) ((m & _S_IFMT) == _S_IFBLK) /* block special */
|
||||
#define S_ISSOCK(m) ((m & _S_IFMT) == _S_IFSOCK) /* socket */
|
||||
|
||||
#define S_ISFIFO(m) ((m & _S_IFMT) == _S_IFIFO) /* fifo */
|
||||
//#define S_ISLNK(m) ((m & _S_IFMT) == _S_IFLNK) /* symbolic link */
|
||||
//#define S_ISWHT(m) ((m & _S_IFMT) == _S_IFWHT) /* whiteout */
|
||||
#define S_ISFIFO(m) ((m & _S_IFMT) == _S_IFIFO) ///< fifo
|
||||
|
||||
/* The following three macros have been changed to reflect
|
||||
access permissions that better reflect the UEFI FAT file system.
|
||||
UEFI only supports Read or Read+Write instead of the *nix
|
||||
rwx paradigm. Thus, using 0777 is the closest analog.
|
||||
*/
|
||||
#define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
|
||||
#define ALLPERMS (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
|
||||
#define DEFFILEMODE (S_IRWXU|S_IRWXG|S_IRWXO) /* 0777 */
|
||||
#define ACCESSPERMS (S_IRWXU|S_IRWXG|S_IRWXO) ///< 0777
|
||||
#define ALLPERMS (S_IRWXU|S_IRWXG|S_IRWXO) ///< 0777
|
||||
#define DEFFILEMODE (S_IRWXU|S_IRWXG|S_IRWXO) ///< 0777
|
||||
|
||||
#define S_BLKSIZE 512 /* block size used in the stat struct */
|
||||
#define S_BLKSIZE 512 ///< block size used in the stat struct
|
||||
|
||||
/*
|
||||
* Definitions of flags stored in file flags word.
|
||||
*
|
||||
* Super-user and owner changeable flags.
|
||||
*/
|
||||
#define UF_SETTABLE 0x0000ffff /* mask of owner changeable flags */
|
||||
#define UF_NODUMP 0x00000001 /* do not dump file */
|
||||
#define UF_IMMUTABLE 0x00000002 /* file may not be changed */
|
||||
#define UF_APPEND 0x00000004 /* writes to file may only append */
|
||||
#define UF_SETTABLE 0x0000ffff ///< mask of owner changeable flags
|
||||
#define UF_NODUMP 0x00000001 ///< do not dump file
|
||||
#define UF_IMMUTABLE 0x00000002 ///< file may not be changed
|
||||
#define UF_APPEND 0x00000004 ///< writes to file may only append
|
||||
/* UF_NOUNLINK 0x00000010 [NOT IMPLEMENTED] */
|
||||
/*
|
||||
* Super-user changeable flags.
|
||||
*/
|
||||
#define SF_SETTABLE 0xffff0000 /* mask of superuser changeable flags */
|
||||
#define SF_ARCHIVED 0x00010000 /* file is archived */
|
||||
#define SF_IMMUTABLE 0x00020000 /* file may not be changed */
|
||||
#define SF_APPEND 0x00040000 /* writes to file may only append */
|
||||
#define SF_SETTABLE 0xffff0000 ///< mask of superuser changeable flags
|
||||
#define SF_ARCHIVED 0x00010000 ///< file is archived
|
||||
#define SF_IMMUTABLE 0x00020000 ///< file may not be changed
|
||||
#define SF_APPEND 0x00040000 ///< writes to file may only append
|
||||
/* SF_NOUNLINK 0x00100000 [NOT IMPLEMENTED] */
|
||||
|
||||
#include <sys/EfiCdefs.h>
|
||||
@@ -206,10 +168,25 @@ struct stat {
|
||||
__BEGIN_DECLS
|
||||
#ifndef __STAT_SYSCALLS_DECLARED
|
||||
#define __STAT_SYSCALLS_DECLARED
|
||||
|
||||
/**
|
||||
**/
|
||||
extern int mkdir (const char *, mode_t);
|
||||
|
||||
/**
|
||||
**/
|
||||
extern int fstat (int, struct stat *);
|
||||
|
||||
/**
|
||||
**/
|
||||
extern int lstat (const char *, struct stat *);
|
||||
|
||||
/**
|
||||
**/
|
||||
extern int stat (const char *, void *);
|
||||
|
||||
/**
|
||||
**/
|
||||
extern int chmod (const char *, mode_t);
|
||||
#endif // __STAT_SYSCALLS_DECLARED
|
||||
__END_DECLS
|
||||
|
Reference in New Issue
Block a user