apps/include/devfs.h

   1 /*
   2     meinOS - A unix-like x86 microkernel operating system
   3     Copyright (C) 2008  Janosch Gräf <janosch.graef@gmx.net>
   4
   5     This program is free software: you can redistribute it and/or modify
   6     it under the terms of the GNU Lesser General Public License as published by
   7     the Free Software Foundation, either version 3 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU Lesser General Public License for more details.
  14
  15     You should have received a copy of the GNU Lesser General Public License
  16     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 #ifndef _DEVFS_H_
  20 #define _DEVFS_H_
  21
  22 #include <sys/types.h>
  23 #include <rpc.h>
  24 #include <limits.h>
  25
  26 #define DEVFS_BUFSIZE PAGE_SIZE
  27
  28 /// Device
  29 typedef struct devfs_dev_S devfs_dev_t;
  30 struct devfs_dev_S {
  31   /// Device name
  32   char *name;
  33   /// Device ID
  34   dev_t id;
  35   /// SHMID
  36   int shmid;
  37   /// SHM buffer
  38   void *shmbuf;
  39   /// Read callback
  40   ssize_t (*func_read)(devfs_dev_t *dev,void *buf,size_t count,off_t offset);
  41   /// Write callback
  42   ssize_t (*func_write)(devfs_dev_t *dev,void *buf,size_t count,off_t offset);
  43   /// User (private) data
  44   void *user_data;
  45 };
  46
  47 #define devfs_curpid rpc_curpid
  48 #define devfs_mainloop() rpc_mainloop(-1)
  49
  50 /**
  51  * Sets callback function for fileread
  52  *  @param dev Device
  53  *  @param func_read Function to fileread handler
  54  */
  55 static inline void devfs_onread(devfs_dev_t *dev,ssize_t (*func_read)(devfs_dev_t *dev,void *buf,size_t count,off_t offset)) {
  56   dev->func_read = func_read;
  57 }
  58
  59 /**
  60  * Sets callback function for filewrite
  61  *  @param dev Device
  62  *  @param func_write Function to filewrite handler
  63  */
  64 static inline void devfs_onwrite(devfs_dev_t *dev,ssize_t (*func_write)(devfs_dev_t *dev,void *buf,size_t count,off_t offset)) {
  65   dev->func_write = func_write;
  66 }
  67
  68 void devfs_init();
  69 devfs_dev_t *devfs_createdev(const char *name);
  70 int devfs_removedev(devfs_dev_t *dev);
  71
  72 #endif