disc_io.h

Go to the documentation of this file.

/*
 disc_io.h
 Interface template for low level disc functions.
 
 Copyright (c) 2006 Michael "Chishm" Chisholm
 Based on code originally written by MightyMax
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
  1. Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation and/or
     other materials provided with the distribution.
  3. The name of the author may not be used to endorse or promote products derived
     from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef OGC_DISC_IO_INCLUDE
#define OGC_DISC_IO_INCLUDE
 
#include <stdint.h>
#include <xetypes.h>
 
#define MAXDEVICES 16
#define DISKIO_ERROR_NO_MEDIA -8
 
#define FEATURE_MEDIUM_CANREAD      0x00000001
#define FEATURE_MEDIUM_CANWRITE     0x00000002
#define FEATURE_XENON_ATA           0x00000100
#define FEATURE_XENON_ATAPI         0x00000200
#define FEATURE_XENON_USB           0x00000400
 
typedef uint32_t sec_t;
 
typedef bool (* FN_MEDIUM_STARTUP)(void) ;
typedef bool (* FN_MEDIUM_ISINSERTED)(void) ;
typedef bool (* FN_MEDIUM_READSECTORS)(sec_t sector, sec_t numSectors, void* buffer) ;
typedef bool (* FN_MEDIUM_WRITESECTORS)(sec_t sector, sec_t numSectors, const void* buffer) ;
typedef bool (* FN_MEDIUM_CLEARSTATUS)(void) ;
typedef bool (* FN_MEDIUM_SHUTDOWN)(void) ;
typedef s32 (* FN_MEDIUM_DEVSECTORS)(void) ;
 
struct DISC_INTERFACE_STRUCT {
    unsigned long           ioType ;
    unsigned long           features ;
    FN_MEDIUM_STARTUP       startup ;
    FN_MEDIUM_ISINSERTED    isInserted ;
    FN_MEDIUM_READSECTORS   readSectors ;
    FN_MEDIUM_WRITESECTORS  writeSectors ;
    FN_MEDIUM_CLEARSTATUS   clearStatus ;
    FN_MEDIUM_SHUTDOWN      shutdown ;
    FN_MEDIUM_DEVSECTORS    sectors;
} ;
 
typedef struct DISC_INTERFACE_STRUCT DISC_INTERFACE ;
 
void register_disc_interface(DISC_INTERFACE *disc_io);
void unregister_disc_interface(DISC_INTERFACE *disc_io);
 
#endif  // define OGC_DISC_IO_INCLUDE