git.sur5r.net Git - cc65/blob - include/dio.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                   dio.h                                   */
   4 /*                                                                           */
   5 /*                       Low-Level diskette I/O functions                    */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000 Christian Groessler <cpg@aladdin.de>                             */
  10 /*                                                                           */
  11 /*                                                                           */
  12 /* This software is provided 'as-is', without any expressed or implied       */
  13 /* warranty.  In no event will the authors be held liable for any damages    */
  14 /* arising from the use of this software.                                    */
  15 /*                                                                           */
  16 /* Permission is granted to anyone to use this software for any purpose,     */
  17 /* including commercial applications, and to alter it and redistribute it    */
  18 /* freely, subject to the following restrictions:                            */
  19 /*                                                                           */
  20 /* 1. The origin of this software must not be misrepresented; you must not   */
  21 /*    claim that you wrote the original software. If you use this software   */
  22 /*    in a product, an acknowledgment in the product documentation would be  */
  23 /*    appreciated but is not required.                                       */
  24 /* 2. Altered source versions must be plainly marked as such, and must not   */
  25 /*    be misrepresented as being the original software.                      */
  26 /* 3. This notice may not be removed or altered from any source              */
  27 /*    distribution.                                                          */
  28 /*                                                                           */
  29 /*****************************************************************************/
  30
  31 #ifndef _DIO_H
  32 #define _DIO_H
  33
  34 typedef unsigned char       driveid_t;
  35 typedef unsigned int        sectnum_t;
  36 typedef unsigned int        sectsize_t;
  37 typedef struct __dhandle_t *dhandle_t;
  38
  39 typedef struct {
  40   unsigned char  head;
  41   unsigned       track;
  42   unsigned       sector;
  43 } dio_phys_pos;
  44
  45
  46 #ifdef __ATARI__
  47 #define dio_query_sectsize(x) ((sectsize_t)128)
  48 #else
  49 #define dio_query_sectsize(x) ((sectsize_t)256)
  50 #endif
  51 /* queries sector size, currently hardcoded */
  52
  53 extern dhandle_t     __fastcall__ dio_open(driveid_t drive_id);
  54 /* open drive for subsequent dio access */
  55
  56 extern unsigned char __fastcall__ dio_close(dhandle_t handle);
  57 /* close drive, returns oserror (0 for success) */
  58
  59 extern unsigned char __fastcall__ dio_read(dhandle_t handle,
  60                                            sectnum_t sect_num,
  61                                            void *buffer);
  62 /* read sector <sect_num> from drive <handle> to memory at <buffer> */
  63 /* the number of bytes transferred depends on the sector size */
  64 /* returns oserror (0 for success) */
  65
  66 extern unsigned char __fastcall__ dio_write(dhandle_t handle,
  67                                             sectnum_t sect_num,
  68                                             const void *buffer);
  69 /* write memory at <buffer> to sector <sect_num> on drive <handle>, no verify */
  70 /* the number of bytes transferred depends on the sector size */
  71 /* returns oserror (0 for success) */
  72
  73 extern unsigned char __fastcall__ dio_write_verify(dhandle_t handle,
  74                                                    sectnum_t sect_num,
  75                                                    const void *buffer);
  76 /* write memory at <buffer> to sector <sect_num> on drive <handle>, verify after write */
  77 /* the number of bytes transferred depends on the sector size */
  78 /* returns oserror (0 for success) */
  79
  80
  81 extern unsigned char __fastcall__ dio_phys_to_log(dhandle_t handle,
  82                                                   const dio_phys_pos *physpos, /* input */
  83                                                   sectnum_t *sectnum);        /* output */
  84 /* convert physical sector address (head/track/sector) to logical sector number */
  85 /* returns oserror (0 for success) */
  86
  87 extern unsigned char __fastcall__ dio_log_to_phys(dhandle_t handle,
  88                                                   const sectnum_t *sectnum,    /* input */
  89                                                   dio_phys_pos *physpos);     /* output */
  90 /* convert logical sector number to physical sector address (head/track/sector) */
  91 /* returns oserror (0 for success) */
  92
  93 #endif /* #ifndef _DIO_H */