nkeynes@1 | 1 | /**
|
nkeynes@561 | 2 | * $Id$
|
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@736 | 22 | #ifdef __cplusplus
|
nkeynes@736 | 23 | extern "C" {
|
nkeynes@736 | 24 | #endif
|
nkeynes@736 | 25 |
|
nkeynes@450 | 26 | #include <stdint.h>
|
nkeynes@450 | 27 | #include "config.h"
|
nkeynes@144 | 28 |
|
nkeynes@1034 | 29 | #define MAPLE_PORTS 4
|
nkeynes@1034 | 30 | #define MAPLE_MAX_DEVICES 24 /* 1 Primary + 5 secondary per port */
|
nkeynes@1034 | 31 | #define MAPLE_USER_SLOTS 2 /* Number of slots to show in configuration */
|
nkeynes@1034 | 32 |
|
nkeynes@1034 | 33 | /* Map devices to a single id from 0..MAPLE_MAX_DEVICES, to simplify
|
nkeynes@1034 | 34 | * configuration. Port is 0..3 (A..D) representing the primary ports, and
|
nkeynes@1034 | 35 | * slot is 0 for the primary, or 1..5 for for one the secondary slots.
|
nkeynes@1034 | 36 | */
|
nkeynes@1034 | 37 | #define MAPLE_DEVID(port,slot) ( (port)|((slot)<<2) )
|
nkeynes@1034 | 38 | #define MAPLE_DEVID_PORT(id) ((id)&0x03)
|
nkeynes@1034 | 39 | #define MAPLE_DEVID_SLOT(id) ((id)>>2)
|
nkeynes@1034 | 40 |
|
nkeynes@1 | 41 | #define MAPLE_CMD_INFO 1 /* Request device information */
|
nkeynes@1 | 42 | #define MAPLE_CMD_EXT_INFO 2 /* Request extended information */
|
nkeynes@1 | 43 | #define MAPLE_CMD_RESET 3 /* Reset device */
|
nkeynes@1 | 44 | #define MAPLE_CMD_SHUTDOWN 4 /* Shutdown device */
|
nkeynes@1 | 45 | #define MAPLE_CMD_GET_COND 9 /* Get condition */
|
nkeynes@1 | 46 | #define MAPLE_CMD_MEM_INFO 10 /* Get memory information */
|
nkeynes@2 | 47 | #define MAPLE_CMD_READ_BLOCK 11 /* Block read */
|
nkeynes@2 | 48 | #define MAPLE_CMD_WRITE_BLOCK 12 /* Block write */
|
nkeynes@1034 | 49 | #define MAPLE_CMD_SYNC_BLOCK 13 /* Block sync */
|
nkeynes@1 | 50 | #define MAPLE_CMD_SET_COND 14 /* Set condition */
|
nkeynes@1 | 51 | #define MAPLE_RESP_INFO 5 /* Device information response */
|
nkeynes@1 | 52 | #define MAPLE_RESP_EXT_INFO 6 /* Extended device information response */
|
nkeynes@1 | 53 | #define MAPLE_RESP_ACK 7 /* Acknowledge command */
|
nkeynes@1 | 54 | #define MAPLE_RESP_DATA 8 /* Bytes read */
|
nkeynes@1 | 55 | #define MAPLE_ERR_NO_RESPONSE -1 /* Device did not respond */
|
nkeynes@1 | 56 | #define MAPLE_ERR_FUNC_UNSUP -2 /* Function code unsupported */
|
nkeynes@1 | 57 | #define MAPLE_ERR_CMD_UNKNOWN -3 /* Command code unknown */
|
nkeynes@1 | 58 | #define MAPLE_ERR_RETRY -4 /* Retry command */
|
nkeynes@1 | 59 | #define MAPLE_ERR_FILE -5 /* File error? */
|
nkeynes@1 | 60 |
|
nkeynes@2 | 61 | #define MAPLE_FUNC_CONTROLLER 0x01000000
|
nkeynes@2 | 62 | #define MAPLE_FUNC_MEMORY 0x02000000
|
nkeynes@2 | 63 | #define MAPLE_FUNC_LCD 0x04000000
|
nkeynes@2 | 64 | #define MAPLE_FUNC_CLOCK 0x08000000
|
nkeynes@2 | 65 | #define MAPLE_FUNC_MICROPHONE 0x10000000
|
nkeynes@2 | 66 | #define MAPLE_FUNC_AR_GUN 0x20000000
|
nkeynes@2 | 67 | #define MAPLE_FUNC_KEYBOARD 0x40000000
|
nkeynes@2 | 68 | #define MAPLE_FUNC_LIGHT_GUN 0x80000000
|
nkeynes@2 | 69 | #define MAPLE_FUNC_PURU_PURU 0x00010000
|
nkeynes@2 | 70 | #define MAPLE_FUNC_MOUSE 0x00020000
|
nkeynes@2 | 71 |
|
nkeynes@1034 | 72 | /* Internal flags, mainly for UI consumption */
|
nkeynes@1034 | 73 | #define MAPLE_GRAB_DONTCARE 0x00
|
nkeynes@1034 | 74 | #define MAPLE_GRAB_YES 0x01
|
nkeynes@1034 | 75 | #define MAPLE_GRAB_NO 0x02
|
nkeynes@1034 | 76 | #define MAPLE_GRAB_MASK 0x03
|
nkeynes@1034 | 77 | #define MAPLE_TYPE_PRIMARY 0x08 /* attaches directly to maple port */
|
nkeynes@1034 | 78 | #define MAPLE_SLOTS_MASK 0xF0 /* number of slots on device (primaries only) */
|
nkeynes@1034 | 79 | #define MAPLE_SLOTS_1 0x10
|
nkeynes@1034 | 80 | #define MAPLE_SLOTS_2 0x20
|
nkeynes@1034 | 81 | #define MAPLE_SLOTS(x) ((((x)->flags)&MAPLE_SLOTS_MASK)>>4)
|
nkeynes@838 | 82 |
|
nkeynes@2 | 83 | #define MAPLE_DEVICE_TAG 0x4D41504C
|
nkeynes@2 | 84 | #define MAPLE_DEVICE(x) ((maple_device_t)x)
|
nkeynes@2 | 85 |
|
nkeynes@1034 | 86 | /* Some convenience methods for VMU handling */
|
nkeynes@1034 | 87 | #define MAPLE_IS_VMU(dev) ((dev)->device_class == &vmu_class)
|
nkeynes@1034 | 88 | #define MAPLE_IS_VMU_CLASS(clz) ((clz) == &vmu_class)
|
nkeynes@1072 | 89 | #define MAPLE_VMU_NAME(dev) (((dev)->get_config(dev))->params[0].value)
|
nkeynes@1072 | 90 | #define MAPLE_SET_VMU_NAME(dev,name) lxdream_set_config_value( (dev)->get_config(dev), 0 ,(name) )
|
nkeynes@1034 | 91 | #define MAPLE_VMU_HAS_NAME(d1,name) (MAPLE_VMU_NAME(d1) == NULL ? name == NULL : \
|
nkeynes@1034 | 92 | name != NULL && strcmp(MAPLE_VMU_NAME(d1),name) == 0)
|
nkeynes@1034 | 93 | #define MAPLE_IS_SAME_VMU(d1,d2) (MAPLE_VMU_NAME(d1) == NULL ? MAPLE_VMU_NAME(d2) == NULL : \
|
nkeynes@1034 | 94 | MAPLE_VMU_NAME(d2) != NULL && strcmp(MAPLE_VMU_NAME(d1),MAPLE_VMU_NAME(d2)) == 0)
|
nkeynes@1034 | 95 |
|
nkeynes@480 | 96 | typedef const struct maple_device_class *maple_device_class_t;
|
nkeynes@144 | 97 | typedef struct maple_device *maple_device_t;
|
nkeynes@144 | 98 |
|
nkeynes@144 | 99 | struct maple_device_class {
|
nkeynes@144 | 100 | const char *name;
|
nkeynes@1034 | 101 | int flags;
|
nkeynes@1072 | 102 |
|
nkeynes@144 | 103 | maple_device_t (*new_device)();
|
nkeynes@144 | 104 | };
|
nkeynes@144 | 105 |
|
nkeynes@31 | 106 | /**
|
nkeynes@31 | 107 | * Table of functions to be implemented by any maple device.
|
nkeynes@31 | 108 | */
|
nkeynes@144 | 109 | struct maple_device {
|
nkeynes@2 | 110 | uint32_t _tag;
|
nkeynes@144 | 111 | maple_device_class_t device_class;
|
nkeynes@2 | 112 | unsigned char ident[112];
|
nkeynes@2 | 113 | unsigned char version[80];
|
nkeynes@1072 | 114 | lxdream_config_group_t (*get_config)(struct maple_device *dev);
|
nkeynes@144 | 115 | void (*attach)(struct maple_device *dev);
|
nkeynes@144 | 116 | void (*detach)(struct maple_device *dev);
|
nkeynes@144 | 117 | void (*destroy)(struct maple_device *dev);
|
nkeynes@460 | 118 | struct maple_device * (*clone)(struct maple_device *dev);
|
nkeynes@2 | 119 | int (*reset)(struct maple_device *dev);
|
nkeynes@2 | 120 | int (*shutdown)(struct maple_device *dev);
|
nkeynes@2 | 121 | int (*get_condition)(struct maple_device *dev,
|
nkeynes@502 | 122 | int function, unsigned char *outbuf, unsigned int *buflen);
|
nkeynes@2 | 123 | int (*set_condition)(struct maple_device *dev,
|
nkeynes@502 | 124 | int function, unsigned char *inbuf, unsigned int buflen);
|
nkeynes@1034 | 125 | int (*get_memory_info)(struct maple_device *dev, int function, unsigned int partition,
|
nkeynes@1034 | 126 | unsigned char *outbuf, unsigned int *buflen);
|
nkeynes@1034 | 127 | int (*read_block)(struct maple_device *dev, int function, unsigned int partition,
|
nkeynes@1034 | 128 | uint32_t block, unsigned int phase, unsigned char *outbuf, unsigned int *buflen);
|
nkeynes@1034 | 129 | int (*write_block)(struct maple_device *dev, int function, unsigned int partition,
|
nkeynes@1034 | 130 | uint32_t block, unsigned int phase, unsigned char *inbuf, unsigned int buflen);
|
nkeynes@850 | 131 | void (*start_gun)(struct maple_device *dev);
|
nkeynes@850 | 132 | void (*stop_gun)(struct maple_device *dev);
|
nkeynes@144 | 133 | };
|
nkeynes@2 | 134 |
|
nkeynes@144 | 135 | extern struct maple_device_class controller_class;
|
nkeynes@608 | 136 | extern struct maple_device_class keyboard_class;
|
nkeynes@850 | 137 | extern struct maple_device_class lightgun_class;
|
nkeynes@608 | 138 | extern struct maple_device_class mouse_class;
|
nkeynes@1034 | 139 | extern struct maple_device_class vmu_class;
|
nkeynes@144 | 140 |
|
nkeynes@447 | 141 | maple_device_t maple_new_device( const gchar *name );
|
nkeynes@144 | 142 | maple_device_t maple_get_device( unsigned int port, unsigned int periph );
|
nkeynes@480 | 143 | const struct maple_device_class *maple_get_device_class( const gchar *name );
|
nkeynes@447 | 144 | const struct maple_device_class **maple_get_device_classes();
|
nkeynes@1072 | 145 | lxdream_config_group_t maple_get_device_config( maple_device_t dev );
|
nkeynes@1 | 146 |
|
nkeynes@1 | 147 | void maple_handle_buffer( uint32_t buffer );
|
nkeynes@2 | 148 | void maple_attach_device( maple_device_t dev, unsigned int port, unsigned int periph );
|
nkeynes@2 | 149 | void maple_detach_device( unsigned int port, unsigned int periph );
|
nkeynes@144 | 150 | void maple_detach_all( );
|
nkeynes@144 | 151 | void maple_reattach_all( );
|
nkeynes@838 | 152 | gboolean maple_should_grab();
|
nkeynes@1 | 153 |
|
nkeynes@1072 | 154 |
|
nkeynes@608 | 155 | /**
|
nkeynes@608 | 156 | * Default destroy implementation that just frees the dev memory.
|
nkeynes@608 | 157 | */
|
nkeynes@608 | 158 | void maple_default_destroy( maple_device_t dev );
|
nkeynes@608 | 159 |
|
nkeynes@736 | 160 | #ifdef __cplusplus
|
nkeynes@736 | 161 | }
|
nkeynes@736 | 162 | #endif
|
nkeynes@736 | 163 |
|
nkeynes@450 | 164 | #endif /* !lxdream_maple_H */
|