device.h

Go to the documentation of this file.

/*
 
MIT License
 
Copyright (c) 2020 PCSX-Redux authors
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#pragma once
 
#include <stdint.h>
 
#include "common/psxlibc/stdio.h"
 
struct File;
 
enum FileAction {
    PSXREAD = 1,
    PSXWRITE = 2,
};
 
enum {
    PSXDTTYPE_CHAR = 0x01,
    PSXDTTYPE_CONS = 0x02,
    PSXDTTYPE_BLOCK = 0x04,
    PSXDTTYPE_RAW = 0x08,
    PSXDTTYPE_FS = 0x10,
};
 
typedef void (*device_init)();
typedef int (*device_open)(struct File *, const char *filename, int mode);
typedef int (*device_action)(struct File *, enum FileAction);
typedef int (*device_close)(struct File *);
typedef int (*device_ioctl)(struct File *, int cmd, int arg);
typedef int (*device_read)(struct File *, void *buffer, int size);
typedef int (*device_write)(struct File *, void *buffer, int size);
typedef int (*device_erase)(struct File *, const char *path);
typedef struct DirEntry *(*device_firstFile)(struct File *file, const char *filename, struct DirEntry *entry);
typedef struct DirEntry *(*device_nextFile)(struct File *file, struct DirEntry *entry);
typedef int (*device_format)(struct File *file);
typedef int (*device_rename)(struct File *oldFile, const char *oldName, struct File *newFile, const char *newName);
typedef void (*device_deinit)();
 
struct Device {
    const char *name;
    uint32_t flags /* PSXDTTYPE_* */;
    uint32_t blockSize;
    const char *desc;
    device_init init;
    device_open open;
    device_action action;
    device_close close;
    device_ioctl ioctl;
    device_read read;
    device_write write;
    device_erase erase;
    void *undelete;
    device_firstFile firstFile;
    device_nextFile nextFile;
    device_format format;
    void *chdir;
    device_rename rename;
    device_deinit deinit;
    void *check;
};