#ifndef _DRIVERS_DRIVERS_H #define _DRIVERS_DRIVERS_H #include #include #include #include /* --- these hooks are how the kernel accesses the device --- */ // XXX hack, this is also in private/kernel/defines.h #ifndef SYS_MAX_PATH_LEN #define SYS_MAX_PATH_LEN 512 #endif struct selectsync; typedef struct selectsync selectsync; typedef status_t (*device_open_hook) (const char *name, uint32 flags, void **cookie); typedef status_t (*device_close_hook) (void *cookie); typedef status_t (*device_free_hook) (void *cookie); typedef status_t (*device_control_hook) (void *cookie, uint32 op, void *data, size_t len); typedef ssize_t (*device_read_hook) (void *cookie, off_t position, void *data, size_t *numBytes); typedef ssize_t (*device_write_hook) (void *cookie, off_t position, const void *data, size_t *numBytes); typedef status_t (*device_select_hook) (void *cookie, uint8 event, uint32 ref, selectsync *sync); typedef status_t (*device_deselect_hook) (void *cookie, uint8 event, selectsync *sync); typedef status_t (*device_readv_hook) (void *cookie, off_t position, const iovec *vec, size_t count, size_t *numBytes); typedef status_t (*device_writev_hook) (void *cookie, off_t position, const iovec *vec, size_t count, size_t *numBytes); #define B_CUR_DRIVER_API_VERSION 2 /* --- the device_hooks structure is a descriptor for the device, giving its entry points. --- */ typedef struct { device_open_hook open; /* called to open the device */ device_close_hook close; /* called to close the device */ device_free_hook free; /* called to free the cookie */ device_control_hook control; /* called to control the device */ device_read_hook read; /* reads from the device */ device_write_hook write; /* writes to the device */ device_select_hook select; /* start select */ device_deselect_hook deselect; /* stop select */ device_readv_hook readv; /* scatter-gather read from the device */ device_writev_hook writev; /* scatter-gather write to the device */ } device_hooks; status_t init_hardware(void); const char **publish_devices(void); device_hooks *find_device(const char *name); status_t init_driver(void); void uninit_driver(void); extern int32 api_version; enum { // called on partition device to get info IOCTL_DEVFS_GET_PARTITION_INFO = 1000, // called on raw device to declare one partition IOCTL_DEVFS_SET_PARTITION, }; typedef struct devfs_partition_info { // offset and size relative to raw device in bytes off_t offset; off_t size; // logical block size in bytes uint32 logical_block_size; // session/partition id uint32 session; uint32 partition; // path of raw device (GET_PARTITION_INFO only) char raw_device[SYS_MAX_PATH_LEN]; } devfs_partition_info; enum { B_GET_DEVICE_SIZE = 1, /* get # bytes */ /* returns size_t in *data */ B_SET_DEVICE_SIZE, /* set # bytes */ /* passed size_t in *data */ B_SET_NONBLOCKING_IO, /* set to non-blocking i/o */ B_SET_BLOCKING_IO, /* set to blocking i/o */ B_GET_READ_STATUS, /* check if can read w/o blocking */ /* returns bool in *data */ B_GET_WRITE_STATUS, /* check if can write w/o blocking */ /* returns bool in *data */ B_GET_GEOMETRY, /* get info about device geometry */ /* returns struct geometry in *data */ B_GET_DRIVER_FOR_DEVICE, /* get the path of the executable serving that device */ B_GET_PARTITION_INFO, /* get info about a device partition */ /* returns struct partition_info in *data */ B_SET_PARTITION, /* create a user-defined partition */ B_FORMAT_DEVICE, /* low-level device format */ B_EJECT_DEVICE, /* eject the media if supported */ B_GET_ICON, /* return device icon (see struct below) */ B_GET_BIOS_GEOMETRY, /* get info about device geometry */ /* as reported by the bios */ /* returns struct geometry in *data */ B_GET_MEDIA_STATUS, /* get status of media. */ /* return status_t in *data: */ /* B_NO_ERROR: media ready */ /* B_DEV_NO_MEDIA: no media */ /* B_DEV_NOT_READY: device not ready */ /* B_DEV_MEDIA_CHANGED: media changed */ /* since open or last B_GET_MEDIA_STATUS */ /* B_DEV_MEDIA_CHANGE_REQUESTED: user */ /* pressed button on drive */ /* B_DEV_DOOR_OPEN: door open */ B_LOAD_MEDIA, /* load the media if supported */ B_GET_BIOS_DRIVE_ID, /* get bios id for this device */ B_SET_UNINTERRUPTABLE_IO, /* prevent cntl-C from interrupting i/o */ B_SET_INTERRUPTABLE_IO, /* allow cntl-C to interrupt i/o */ B_FLUSH_DRIVE_CACHE, /* flush drive cache */ B_GET_NEXT_OPEN_DEVICE = 1000, /* iterate through open devices */ B_ADD_FIXED_DRIVER, /* private */ B_REMOVE_FIXED_DRIVER, /* private */ B_AUDIO_DRIVER_BASE = 8000, /* base for codes in audio_driver.h */ B_MIDI_DRIVER_BASE = 8100, /* base for codes in midi_driver.h */ B_JOYSTICK_DRIVER_BASE = 8200, /* base for codes in joystick.h */ B_GRAPHIC_DRIVER_BASE = 8300, /* base for codes in graphic_driver.h */ B_DEVICE_OP_CODES_END = 9999 /* end of Be-defined contol id's */ }; /* --- geometry structure for the B_GET_GEOMETRY opcode --- */ typedef struct { uint32 bytes_per_sector; /* sector size in bytes */ uint32 sectors_per_track; /* # sectors per track */ uint32 cylinder_count; /* # cylinders */ uint32 head_count; /* # heads */ uchar device_type; /* type */ bool removable; /* non-zero if removable */ bool read_only; /* non-zero if read only */ bool write_once; /* non-zero if write-once */ } device_geometry; /* --- Be-defined device types returned by B_GET_GEOMETRY. Use these if it makes sense for your device. --- */ enum { B_DISK = 0, /* Hard disks, floppy disks, etc. */ B_TAPE, /* Tape drives */ B_PRINTER, /* Printers */ B_CPU, /* CPU devices */ B_WORM, /* Write-once, read-many devives */ B_CD, /* CD ROMS */ B_SCANNER, /* Scanners */ B_OPTICAL, /* Optical devices */ B_JUKEBOX, /* Jukeboxes */ B_NETWORK /* Network devices */ }; /* --- partition_info structure used by B_GET_PARTITION_INFO and B_SET_PARTITION --- */ typedef struct { off_t offset; /* offset (in bytes) */ off_t size; /* size (in bytes) */ int32 logical_block_size; /* logical block size of partition */ int32 session; /* id of session */ int32 partition; /* id of partition */ char device[256]; /* path to the physical device */ } partition_info; /* --- driver_path structure returned by the B_GET_DRIVER_FOR_DEVICE --- */ typedef char driver_path[256]; /* --- open_device_iterator structure used by the B_GET_NEXT_OPEN_DEVICE opcode --- */ typedef struct { uint32 cookie; /* must be set to 0 before iterating */ char device[256]; /* device path */ } open_device_iterator; /* --- icon structure for the B_GET_ICON opcode --- */ typedef struct { int32 icon_size; /* icon size requested */ void *icon_data; /* where to put 'em (usually BBitmap->Bits()) */ } device_icon; #endif /* _DRIVERS_DRIVERS_H */