Remove trailings spaces from CBM-related asm files

[cc65] / include / dio.h

diff --git a/include/dio.h b/include/dio.h
index ad5c3df81753efdce53c3cb0565ebe53620021d2..4201728cc9812045688c9de106ceaf966e518e4a 100644 (file)
--- a/include/dio.h
+++ b/include/dio.h
@@ -6,7 +6,7 @@
 /*                                                                           */
 /*                                                                           */
 /*                                                                           */
-/* (C) 2000 Christian Groessler <cpg@aladdin.de>                             */
+/* (C) 2005 Christian Groessler <chris@groessler.org>                        */
 /*                                                                           */
 /*                                                                           */
 /* This software is provided 'as-is', without any expressed or implied       */
@@ -28,44 +28,86 @@
 /*                                                                           */
 /*****************************************************************************/
 
+
+
 #ifndef _DIO_H
 #define _DIO_H
 
-typedef unsigned char       _driveid_t;
-typedef unsigned int        _sectnum_t;
-typedef unsigned int        _sectsize_t;
-typedef struct __dhandle_t *_dhandle_t;
+
+
+/* Please note: All functions in this file will set _oserror *and* return its
+** value. The only exception is dio_open, which will return NULL, but _oserror
+** will be set. All function will also set _oserror in case of successful
+** execution, effectively clearing it.
+*/
+
+
+
+/*****************************************************************************/
+/*                                   Data                                    */
+/*****************************************************************************/
+
+
+
+typedef struct __dhandle_t *dhandle_t;
 
 typedef struct {
   unsigned char  head;
   unsigned       track;
   unsigned       sector;
-} _dio_phys_pos;
-
-
-#ifdef __ATARI__
-#define _dio_query_sectsize(x) ((_sectsize_t)128)
-#else
-#define _dio_query_sectsize(x) ((_sectsize_t)256)
-#endif
-
-extern _dhandle_t    __fastcall__ _dio_open(_driveid_t drive_id);
-extern unsigned char __fastcall__ _dio_close(_dhandle_t handle);
-extern unsigned char __fastcall__ _dio_read(_dhandle_t handle,
-                                            _sectnum_t sect_num,
-                                            void *buffer);
-extern unsigned char __fastcall__ _dio_write(_dhandle_t handle,
-                                             _sectnum_t sect_num,
+} dio_phys_pos;
+
+
+
+/*****************************************************************************/
+/*                                   Code                                    */
+/*****************************************************************************/
+
+
+
+unsigned __fastcall__ dio_query_sectsize (dhandle_t handle);
+/* returns sector size */
+
+unsigned __fastcall__ dio_query_sectcount (dhandle_t handle);
+/* returns sector count */
+
+dhandle_t __fastcall__ dio_open (unsigned char device);
+/* open device for subsequent dio access */
+
+unsigned char __fastcall__ dio_close (dhandle_t handle);
+/* close device, returns oserror (0 for success) */
+
+unsigned char __fastcall__ dio_read (dhandle_t handle,
+                                     unsigned sect_num,
+                                     void *buffer);
+/* read sector <sect_num> from device <handle> to memory at <buffer> */
+/* the number of bytes transferred depends on the sector size */
+/* returns oserror (0 for success) */
+
+unsigned char __fastcall__ dio_write (dhandle_t handle,
+                                      unsigned sect_num,
+                                      const void *buffer);
+/* write memory at <buffer> to sector <sect_num> on device <handle>, no verify */
+/* the number of bytes transferred depends on the sector size */
+/* returns oserror (0 for success) */
+
+unsigned char __fastcall__ dio_write_verify (dhandle_t handle,
+                                             unsigned sect_num,
                                              const void *buffer);
-extern unsigned char __fastcall__ _dio_write_verify(_dhandle_t handle,
-                                                    _sectnum_t sect_num,
-                                                    const void *buffer);
-
-extern unsigned char __fastcall__ _dio_phys_to_log(_dhandle_t handle,
-                                                   const _dio_phys_pos *physpos, /* input */
-                                                   _sectnum_t *sectnum);         /* output */
-extern unsigned char __fastcall__ _dio_log_to_phys(_dhandle_t handle,
-                                                   _dio_phys_pos *physpos,       /* output */
-                                                   const _sectnum_t *sectnum);   /* input */
+/* write memory at <buffer> to sector <sect_num> on device <handle>, verify after write */
+/* the number of bytes transferred depends on the sector size */
+/* returns oserror (0 for success) */
+
+unsigned char __fastcall__ dio_phys_to_log (dhandle_t handle,
+                                            const dio_phys_pos *physpos, /* input */
+                                            unsigned *sectnum);          /* output */
+/* convert physical sector address (head/track/sector) to logical sector number */
+/* returns oserror (0 for success) */
+
+unsigned char __fastcall__ dio_log_to_phys (dhandle_t handle,
+                                            const unsigned *sectnum, /* input */
+                                            dio_phys_pos *physpos);  /* output */
+/* convert logical sector number to physical sector address (head/track/sector) */
+/* returns oserror (0 for success) */
 
 #endif /* #ifndef _DIO_H */