driver.h

Go to the documentation of this file.

/*
 * Line6 Linux USB driver - 0.9.1beta
 *
 * Copyright (C) 2004-2010 Markus Grabner ([email protected])
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License as
 *  published by the Free Software Foundation, version 2.
 *
 */

#ifndef DRIVER_H
#define DRIVER_H

#include <linux/spinlock.h>
#include <linux/usb.h>
#include <sound/core.h>

#include "midi.h"

#define DRIVER_NAME "line6usb"

#if defined(CONFIG_LINE6_USB_DUMP_CTRL) || defined(CONFIG_LINE6_USB_DUMP_MIDI) || defined(CONFIG_LINE6_USB_DUMP_PCM)
#define CONFIG_LINE6_USB_DUMP_ANY
#endif

#define LINE6_TIMEOUT 1
#define LINE6_MAX_DEVICES 8
#define LINE6_BUFSIZE_LISTEN 32
#define LINE6_MESSAGE_MAXLEN 256

/*
    Line6 MIDI control commands
*/
#define LINE6_PARAM_CHANGE   0xb0
#define LINE6_PROGRAM_CHANGE 0xc0
#define LINE6_SYSEX_BEGIN    0xf0
#define LINE6_SYSEX_END      0xf7
#define LINE6_RESET          0xff

/*
    MIDI channel for messages initiated by the host
    (and eventually echoed back by the device)
*/
#define LINE6_CHANNEL_HOST   0x00

/*
    MIDI channel for messages initiated by the device
*/
#define LINE6_CHANNEL_DEVICE 0x02

#define LINE6_CHANNEL_UNKNOWN 5 /* don't know yet what this is good for */

#define LINE6_CHANNEL_MASK 0x0f

#ifdef CONFIG_LINE6_USB_DEBUG
#define DEBUG_MESSAGES(x) (x)
#else
#define DEBUG_MESSAGES(x)
#endif

#define MISSING_CASE    \
    printk(KERN_ERR "line6usb driver bug: missing case in %s:%d\n", \
        __FILE__, __LINE__)

#define CHECK_RETURN(x)     \
do {                \
    err = x;        \
    if (err < 0)        \
        return err; \
} while (0)

#define CHECK_STARTUP_PROGRESS(x, n)    \
do {                    \
    if ((x) >= (n))         \
        return;         \
    x = (n);            \
} while (0)

extern const unsigned char line6_midi_id[3];
extern struct usb_line6 *line6_devices[LINE6_MAX_DEVICES];

static const int SYSEX_DATA_OFS = sizeof(line6_midi_id) + 3;
static const int SYSEX_EXTRA_SIZE = sizeof(line6_midi_id) + 4;

struct line6_properties {
    int device_bit;

    const char *id;

    const char *name;

    int capabilities;
};

struct usb_line6 {
    struct usb_device *usbdev;

    int product;

    const struct line6_properties *properties;

    int interface_number;

    int interval;

    int max_packet_size;

    struct device *ifcdev;

    struct snd_card *card;

    struct snd_line6_pcm *line6pcm;

    struct snd_line6_midi *line6midi;

    int ep_control_read;

    int ep_control_write;

    struct urb *urb_listen;

    unsigned char *buffer_listen;

    unsigned char *buffer_message;

    int message_length;
};

extern char *line6_alloc_sysex_buffer(struct usb_line6 *line6, int code1,
                      int code2, int size);
extern ssize_t line6_nop_read(struct device *dev,
                  struct device_attribute *attr, char *buf);
extern ssize_t line6_nop_write(struct device *dev,
                   struct device_attribute *attr,
                   const char *buf, size_t count);
extern int line6_read_data(struct usb_line6 *line6, int address, void *data,
               size_t datalen);
extern int line6_read_serial_number(struct usb_line6 *line6,
                    int *serial_number);
extern int line6_send_program(struct usb_line6 *line6, u8 value);
extern int line6_send_raw_message(struct usb_line6 *line6, const char *buffer,
                  int size);
extern int line6_send_raw_message_async(struct usb_line6 *line6,
                    const char *buffer, int size);
extern int line6_send_sysex_message(struct usb_line6 *line6,
                    const char *buffer, int size);
extern int line6_send_sysex_message_async(struct usb_line6 *line6,
                      const char *buffer, int size);
extern ssize_t line6_set_raw(struct device *dev, struct device_attribute *attr,
                 const char *buf, size_t count);
extern void line6_start_timer(struct timer_list *timer, unsigned int msecs,
                  void (*function) (unsigned long),
                  unsigned long data);
extern int line6_transmit_parameter(struct usb_line6 *line6, int param,
                    u8 value);
extern int line6_version_request_async(struct usb_line6 *line6);
extern int line6_write_data(struct usb_line6 *line6, int address, void *data,
                size_t datalen);

#ifdef CONFIG_LINE6_USB_DUMP_ANY
extern void line6_write_hexdump(struct usb_line6 *line6, char dir,
                const unsigned char *buffer, int size);
#endif

#endif