syslinux/com32/lib/sys/file.h

   1 #ident "$Id: file.h,v 1.4 2004/11/23 23:43:02 hpa Exp $"
   2 /* ----------------------------------------------------------------------- *
   3  *
   4  *   Copyright 2003-2004 H. Peter Anvin - All Rights Reserved
   5  *
   6  *   Permission is hereby granted, free of charge, to any person
   7  *   obtaining a copy of this software and associated documentation
   8  *   files (the "Software"), to deal in the Software without
   9  *   restriction, including without limitation the rights to use,
  10  *   copy, modify, merge, publish, distribute, sublicense, and/or
  11  *   sell copies of the Software, and to permit persons to whom
  12  *   the Software is furnished to do so, subject to the following
  13  *   conditions:
  14  *
  15  *   The above copyright notice and this permission notice shall
  16  *   be included in all copies or substantial portions of the Software.
  17  *
  18  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  19  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  20  *   OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21  *   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  22  *   HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  23  *   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  *   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  25  *   OTHER DEALINGS IN THE SOFTWARE.
  26  *
  27  * ----------------------------------------------------------------------- */
  28
  29 /*
  30  * file.h
  31  *
  32  * Internal implementation of file I/O for COM32
  33  */
  34
  35 #ifndef _COM32_SYS_FILE_H
  36 #define _COM32_SYS_FILE_H
  37
  38 #include <inttypes.h>
  39 #include <stdlib.h>
  40 #include <sys/types.h>
  41 #include <dev.h>
  42 #include <fcntl.h>
  43
  44 /* Device structure; contains the relevant operations */
  45
  46 struct file_info;
  47
  48 #define __DEV_MAGIC     0xf4e7
  49 #define __DEV_TTY       0x0001  /* TTY - must be bit 0 */
  50 #define __DEV_FILE      0x0002  /* Ordinary file */
  51 #define __DEV_OUTPUT    0x0004  /* This is an output device */
  52 #define __DEV_INPUT     0       /* Dummy */
  53 #define __DEV_ERROR     0x0008  /* This is the error device */
  54 #define __DEV_NULL      0x0010  /* This is the null device */
  55
  56 struct input_dev {
  57   uint16_t dev_magic;           /* Magic number */
  58   uint16_t flags;               /* Flags */
  59   int fileflags;                /* Permitted file flags */
  60   ssize_t (*read)(struct file_info *, void *, size_t);
  61   int (*close)(struct file_info *);
  62 };
  63 struct output_dev {
  64   uint16_t dev_magic;           /* Magic number */
  65   uint16_t flags;               /* Flags */
  66   int fileflags;
  67   ssize_t (*write)(struct file_info *, const void *, size_t);
  68   int (*close)(struct file_info *);
  69 };
  70
  71 /* File structure */
  72
  73 #define NFILES 32               /* Number of files to support */
  74 #define MAXBLOCK 16384          /* Defined by ABI */
  75
  76 struct file_info {
  77   const struct input_dev *iop;  /* Input operations */
  78   const struct output_dev *oop; /* Output operations */
  79
  80   /* Structure used for input blocking */
  81   struct {
  82     int blocklg2;               /* Blocksize log 2 */
  83     size_t offset;              /* Current file offset */
  84     size_t length;              /* Total file length */
  85     uint16_t filedes;           /* File descriptor */
  86     uint16_t _filler;           /* Unused */
  87     size_t nbytes;              /* Number of bytes available in buffer */
  88     char *datap;                /* Current data pointer */
  89     char buf[MAXBLOCK];
  90   } i;
  91 };
  92
  93 extern struct file_info __file_info[NFILES];
  94
  95 /* Line input discipline */
  96 ssize_t __line_input(struct file_info *fp, char *buf, size_t bufsize,
  97                      ssize_t (*get_char)(struct file_info *, void *, size_t));
  98
  99 #endif /* _COM32_SYS_FILE_H */