programs/include/cdi/scsi.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 CDI_SCSI_H_INCLUDED
  20 #define CDI_SCSI_H_INCLUDED
  21
  22 #include <stdint.h>
  23 #include <stddef.h>
  24
  25 #include <cdi.h>
  26
  27 // SCSI-Paket
  28 struct cdi_scsi_packet {
  29   // Buffer zum Senden oder Empfangen von Daten
  30   void *buffer;
  31
  32   // Groesse des Buffers
  33   size_t bufsize;
  34
  35   // Ob gelesen oder geschrieben werden soll
  36   enum {
  37     CDI_SCSI_NODATA,
  38     CDI_SCSI_READ,
  39     CDI_SCSI_WRITE,
  40   } direction;
  41
  42   // SCSI Command
  43   uint8_t command[16];
  44
  45   // Groesse des SCSI Commands
  46   size_t cmdsize;
  47 };
  48
  49 // SCSI-Geraet
  50 struct cdi_scsi_device {
  51   struct cdi_device dev;
  52 };
  53
  54 // SCSI-Driver
  55 struct cdi_scsi_driver {
  56   struct cdi_driver drv;
  57
  58   int (*request)(struct cdi_scsi_device *device,struct cdi_scsi_packet *packet);
  59 };
  60
  61 /**
  62  * Ein SCSI-Paket allozieren
  63  *
  64  * @param size Benoetigte Groesse
  65  *
  66  * @return Pointer auf das Paket oder NULL im Fehlerfall
  67  */
  68 struct cdi_scsi_packet* cdi_scsi_packet_alloc(size_t size);
  69
  70 /**
  71  * Ein SCSI-Paket freigeben
  72  *
  73  * @param packet Pointer auf das Paket
  74  */
  75 void cdi_scsi_packet_free(struct cdi_scsi_packet* packet);
  76
  77 /**
  78  * Initialisiert die Datenstrukturen fuer einen SCSI-Treiber
  79  */
  80 void cdi_scsi_driver_init(struct cdi_scsi_driver* driver);
  81
  82 /**
  83  * Deinitialisiert die Datenstrukturen fuer einen SCSI-Treiber
  84  */
  85 void cdi_scsi_driver_destroy(struct cdi_scsi_driver* driver);
  86
  87 /**
  88  * Registiert einen SCSI-Treiber
  89  */
  90 void cdi_scsi_driver_register(struct cdi_scsi_driver* driver);
  91
  92 #endif