Search
lxdream.org :: lxdream/src/maple/maple.h
lxdream 0.9.1
released Jun 29
Download Now
filename src/maple/maple.h
changeset 770:429ff505c450
prev736:a02d1475ccfd
next838:9abb2fa58934
author nkeynes
date Mon Jul 28 03:41:25 2008 +0000 (12 years ago)
permissions -rw-r--r--
last change Implement key-binding configuration pane for Cocoa UI
Minor tweaks for consistency and static-correctness
file annotate diff log raw
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@1
    29
#define MAPLE_CMD_INFO        1  /* Request device information */
nkeynes@1
    30
#define MAPLE_CMD_EXT_INFO    2  /* Request extended information */
nkeynes@1
    31
#define MAPLE_CMD_RESET       3  /* Reset device */
nkeynes@1
    32
#define MAPLE_CMD_SHUTDOWN    4  /* Shutdown device */
nkeynes@1
    33
#define MAPLE_CMD_GET_COND    9  /* Get condition */
nkeynes@1
    34
#define MAPLE_CMD_MEM_INFO    10 /* Get memory information */
nkeynes@2
    35
#define MAPLE_CMD_READ_BLOCK  11 /* Block read */
nkeynes@2
    36
#define MAPLE_CMD_WRITE_BLOCK 12 /* Block write */
nkeynes@1
    37
#define MAPLE_CMD_SET_COND    14 /* Set condition */
nkeynes@1
    38
#define MAPLE_RESP_INFO       5  /* Device information response */
nkeynes@1
    39
#define MAPLE_RESP_EXT_INFO   6  /* Extended device information response */
nkeynes@1
    40
#define MAPLE_RESP_ACK        7  /* Acknowledge command */
nkeynes@1
    41
#define MAPLE_RESP_DATA       8  /* Bytes read */
nkeynes@1
    42
#define MAPLE_ERR_NO_RESPONSE -1 /* Device did not respond */
nkeynes@1
    43
#define MAPLE_ERR_FUNC_UNSUP  -2 /* Function code unsupported */
nkeynes@1
    44
#define MAPLE_ERR_CMD_UNKNOWN -3 /* Command code unknown */
nkeynes@1
    45
#define MAPLE_ERR_RETRY       -4 /* Retry command */
nkeynes@1
    46
#define MAPLE_ERR_FILE        -5 /* File error? */
nkeynes@1
    47
nkeynes@2
    48
#define MAPLE_FUNC_CONTROLLER 0x01000000
nkeynes@2
    49
#define MAPLE_FUNC_MEMORY     0x02000000
nkeynes@2
    50
#define MAPLE_FUNC_LCD        0x04000000
nkeynes@2
    51
#define MAPLE_FUNC_CLOCK      0x08000000
nkeynes@2
    52
#define MAPLE_FUNC_MICROPHONE 0x10000000
nkeynes@2
    53
#define MAPLE_FUNC_AR_GUN     0x20000000
nkeynes@2
    54
#define MAPLE_FUNC_KEYBOARD   0x40000000
nkeynes@2
    55
#define MAPLE_FUNC_LIGHT_GUN  0x80000000
nkeynes@2
    56
#define MAPLE_FUNC_PURU_PURU  0x00010000
nkeynes@2
    57
#define MAPLE_FUNC_MOUSE      0x00020000
nkeynes@2
    58
nkeynes@2
    59
#define MAPLE_DEVICE_TAG 0x4D41504C
nkeynes@2
    60
#define MAPLE_DEVICE(x) ((maple_device_t)x)
nkeynes@2
    61
nkeynes@480
    62
typedef const struct maple_device_class *maple_device_class_t;
nkeynes@144
    63
typedef struct maple_device *maple_device_t;
nkeynes@144
    64
nkeynes@144
    65
struct maple_device_class {
nkeynes@144
    66
    const char *name;
nkeynes@144
    67
    maple_device_t (*new_device)();
nkeynes@144
    68
};
nkeynes@144
    69
nkeynes@31
    70
/**
nkeynes@31
    71
 * Table of functions to be implemented by any maple device.
nkeynes@31
    72
 */
nkeynes@144
    73
struct maple_device {
nkeynes@2
    74
    uint32_t _tag;
nkeynes@144
    75
    maple_device_class_t device_class;
nkeynes@2
    76
    unsigned char ident[112];
nkeynes@2
    77
    unsigned char version[80];
nkeynes@450
    78
    lxdream_config_entry_t (*get_config)(struct maple_device *dev);
nkeynes@770
    79
    void (*set_config_value)(struct maple_device *dev, unsigned int key, const gchar *value);
nkeynes@144
    80
    void (*attach)(struct maple_device *dev);
nkeynes@144
    81
    void (*detach)(struct maple_device *dev);
nkeynes@144
    82
    void (*destroy)(struct maple_device *dev);
nkeynes@460
    83
    struct maple_device * (*clone)(struct maple_device *dev);
nkeynes@2
    84
    int (*reset)(struct maple_device *dev);
nkeynes@2
    85
    int (*shutdown)(struct maple_device *dev);
nkeynes@2
    86
    int (*get_condition)(struct maple_device *dev,
nkeynes@502
    87
                         int function, unsigned char *outbuf, unsigned int *buflen);
nkeynes@2
    88
    int (*set_condition)(struct maple_device *dev,
nkeynes@502
    89
                         int function, unsigned char *inbuf, unsigned int buflen);
nkeynes@2
    90
    int (*read_block)(struct maple_device *dev,
nkeynes@502
    91
                      int function, uint32_t block, unsigned char *outbuf, unsigned int *buflen);
nkeynes@2
    92
    int (*write_block)(struct maple_device *dev,
nkeynes@502
    93
                       int function, uint32_t block, unsigned char *inbuf, unsigned int buflen);
nkeynes@144
    94
};
nkeynes@2
    95
nkeynes@144
    96
extern struct maple_device_class controller_class;
nkeynes@608
    97
extern struct maple_device_class keyboard_class;
nkeynes@608
    98
extern struct maple_device_class mouse_class;
nkeynes@144
    99
nkeynes@447
   100
maple_device_t maple_new_device( const gchar *name );
nkeynes@144
   101
maple_device_t maple_get_device( unsigned int port, unsigned int periph );
nkeynes@480
   102
const struct maple_device_class *maple_get_device_class( const gchar *name );
nkeynes@447
   103
const struct maple_device_class **maple_get_device_classes();
nkeynes@450
   104
lxdream_config_entry_t maple_get_device_config( maple_device_t dev );
nkeynes@770
   105
void maple_set_device_config_value( maple_device_t dev, unsigned int key, const gchar *value );
nkeynes@1
   106
nkeynes@1
   107
void maple_handle_buffer( uint32_t buffer );
nkeynes@2
   108
void maple_attach_device( maple_device_t dev, unsigned int port, unsigned int periph );
nkeynes@2
   109
void maple_detach_device( unsigned int port, unsigned int periph );
nkeynes@144
   110
void maple_detach_all( );
nkeynes@144
   111
void maple_reattach_all( );
nkeynes@1
   112
nkeynes@608
   113
/**
nkeynes@608
   114
 * Default destroy implementation that just frees the dev memory.
nkeynes@608
   115
 */
nkeynes@608
   116
void maple_default_destroy( maple_device_t dev );
nkeynes@608
   117
nkeynes@736
   118
#ifdef __cplusplus
nkeynes@736
   119
}
nkeynes@736
   120
#endif
nkeynes@736
   121
nkeynes@450
   122
#endif /* !lxdream_maple_H */
.