Search
lxdream.org :: lxdream/src/maple/maple.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/maple/maple.h
changeset 502:c4ecae2b1b5e
prev480:d28c2992f5ee
next561:533f6b478071
author nkeynes
date Thu Nov 08 11:54:16 2007 +0000 (12 years ago)
permissions -rw-r--r--
last change Add sh4ptr_t type, start converting bare pointer refs to it
file annotate diff log raw
nkeynes@1
     1
/**
nkeynes@502
     2
 * $Id: maple.h,v 1.10 2007-11-08 11:54:16 nkeynes Exp $
nkeynes@31
     3
 *
nkeynes@31
     4
 * Maple bus definitions
nkeynes@31
     5
 *
nkeynes@31
     6
 * Copyright (c) 2005 Nathan Keynes.
nkeynes@31
     7
 *
nkeynes@31
     8
 * This program is free software; you can redistribute it and/or modify
nkeynes@31
     9
 * it under the terms of the GNU General Public License as published by
nkeynes@31
    10
 * the Free Software Foundation; either version 2 of the License, or
nkeynes@31
    11
 * (at your option) any later version.
nkeynes@31
    12
 *
nkeynes@31
    13
 * This program is distributed in the hope that it will be useful,
nkeynes@31
    14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
nkeynes@31
    15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
nkeynes@31
    16
 * GNU General Public License for more details.
nkeynes@1
    17
 */
nkeynes@31
    18
nkeynes@450
    19
#ifndef lxdream_maple_H
nkeynes@450
    20
#define lxdream_maple_H 1
nkeynes@1
    21
nkeynes@450
    22
#include <stdint.h>
nkeynes@450
    23
#include "config.h"
nkeynes@144
    24
nkeynes@1
    25
#define MAPLE_CMD_INFO        1  /* Request device information */
nkeynes@1
    26
#define MAPLE_CMD_EXT_INFO    2  /* Request extended information */
nkeynes@1
    27
#define MAPLE_CMD_RESET       3  /* Reset device */
nkeynes@1
    28
#define MAPLE_CMD_SHUTDOWN    4  /* Shutdown device */
nkeynes@1
    29
#define MAPLE_CMD_GET_COND    9  /* Get condition */
nkeynes@1
    30
#define MAPLE_CMD_MEM_INFO    10 /* Get memory information */
nkeynes@2
    31
#define MAPLE_CMD_READ_BLOCK  11 /* Block read */
nkeynes@2
    32
#define MAPLE_CMD_WRITE_BLOCK 12 /* Block write */
nkeynes@1
    33
#define MAPLE_CMD_SET_COND    14 /* Set condition */
nkeynes@1
    34
#define MAPLE_RESP_INFO       5  /* Device information response */
nkeynes@1
    35
#define MAPLE_RESP_EXT_INFO   6  /* Extended device information response */
nkeynes@1
    36
#define MAPLE_RESP_ACK        7  /* Acknowledge command */
nkeynes@1
    37
#define MAPLE_RESP_DATA       8  /* Bytes read */
nkeynes@1
    38
#define MAPLE_ERR_NO_RESPONSE -1 /* Device did not respond */
nkeynes@1
    39
#define MAPLE_ERR_FUNC_UNSUP  -2 /* Function code unsupported */
nkeynes@1
    40
#define MAPLE_ERR_CMD_UNKNOWN -3 /* Command code unknown */
nkeynes@1
    41
#define MAPLE_ERR_RETRY       -4 /* Retry command */
nkeynes@1
    42
#define MAPLE_ERR_FILE        -5 /* File error? */
nkeynes@1
    43
nkeynes@2
    44
#define MAPLE_FUNC_CONTROLLER 0x01000000
nkeynes@2
    45
#define MAPLE_FUNC_MEMORY     0x02000000
nkeynes@2
    46
#define MAPLE_FUNC_LCD        0x04000000
nkeynes@2
    47
#define MAPLE_FUNC_CLOCK      0x08000000
nkeynes@2
    48
#define MAPLE_FUNC_MICROPHONE 0x10000000
nkeynes@2
    49
#define MAPLE_FUNC_AR_GUN     0x20000000
nkeynes@2
    50
#define MAPLE_FUNC_KEYBOARD   0x40000000
nkeynes@2
    51
#define MAPLE_FUNC_LIGHT_GUN  0x80000000
nkeynes@2
    52
#define MAPLE_FUNC_PURU_PURU  0x00010000
nkeynes@2
    53
#define MAPLE_FUNC_MOUSE      0x00020000
nkeynes@2
    54
nkeynes@2
    55
#define MAPLE_DEVICE_TAG 0x4D41504C
nkeynes@2
    56
#define MAPLE_DEVICE(x) ((maple_device_t)x)
nkeynes@2
    57
nkeynes@480
    58
typedef const struct maple_device_class *maple_device_class_t;
nkeynes@144
    59
typedef struct maple_device *maple_device_t;
nkeynes@144
    60
nkeynes@144
    61
struct maple_device_class {
nkeynes@144
    62
    const char *name;
nkeynes@144
    63
    maple_device_t (*new_device)();
nkeynes@144
    64
};
nkeynes@144
    65
nkeynes@31
    66
/**
nkeynes@31
    67
 * Table of functions to be implemented by any maple device.
nkeynes@31
    68
 */
nkeynes@144
    69
struct maple_device {
nkeynes@2
    70
    uint32_t _tag;
nkeynes@144
    71
    maple_device_class_t device_class;
nkeynes@2
    72
    unsigned char ident[112];
nkeynes@2
    73
    unsigned char version[80];
nkeynes@450
    74
    lxdream_config_entry_t (*get_config)(struct maple_device *dev);
nkeynes@144
    75
    void (*attach)(struct maple_device *dev);
nkeynes@144
    76
    void (*detach)(struct maple_device *dev);
nkeynes@144
    77
    void (*destroy)(struct maple_device *dev);
nkeynes@460
    78
    struct maple_device * (*clone)(struct maple_device *dev);
nkeynes@2
    79
    int (*reset)(struct maple_device *dev);
nkeynes@2
    80
    int (*shutdown)(struct maple_device *dev);
nkeynes@2
    81
    int (*get_condition)(struct maple_device *dev,
nkeynes@502
    82
                         int function, unsigned char *outbuf, unsigned int *buflen);
nkeynes@2
    83
    int (*set_condition)(struct maple_device *dev,
nkeynes@502
    84
                         int function, unsigned char *inbuf, unsigned int buflen);
nkeynes@2
    85
    int (*read_block)(struct maple_device *dev,
nkeynes@502
    86
                      int function, uint32_t block, unsigned char *outbuf, unsigned int *buflen);
nkeynes@2
    87
    int (*write_block)(struct maple_device *dev,
nkeynes@502
    88
                       int function, uint32_t block, unsigned char *inbuf, unsigned int buflen);
nkeynes@144
    89
};
nkeynes@2
    90
nkeynes@144
    91
extern struct maple_device_class controller_class;
nkeynes@144
    92
nkeynes@447
    93
maple_device_t maple_new_device( const gchar *name );
nkeynes@144
    94
maple_device_t maple_get_device( unsigned int port, unsigned int periph );
nkeynes@480
    95
const struct maple_device_class *maple_get_device_class( const gchar *name );
nkeynes@447
    96
const struct maple_device_class **maple_get_device_classes();
nkeynes@450
    97
lxdream_config_entry_t maple_get_device_config( maple_device_t dev );
nkeynes@1
    98
nkeynes@1
    99
void maple_handle_buffer( uint32_t buffer );
nkeynes@2
   100
void maple_attach_device( maple_device_t dev, unsigned int port, unsigned int periph );
nkeynes@2
   101
void maple_detach_device( unsigned int port, unsigned int periph );
nkeynes@144
   102
void maple_detach_all( );
nkeynes@144
   103
void maple_reattach_all( );
nkeynes@1
   104
nkeynes@450
   105
#endif /* !lxdream_maple_H */
.