Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 1 | /* |
Markus Grabner | e1a164d | 2010-08-23 01:08:25 +0200 | [diff] [blame] | 2 | * Line6 Linux USB driver - 0.9.1beta |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 3 | * |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 4 | * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at) |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU General Public License as |
| 8 | * published by the Free Software Foundation, version 2. |
| 9 | * |
| 10 | */ |
| 11 | |
| 12 | #ifndef POD_H |
| 13 | #define POD_H |
| 14 | |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 15 | #include <linux/interrupt.h> |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 16 | #include <linux/spinlock.h> |
| 17 | #include <linux/usb.h> |
| 18 | #include <linux/wait.h> |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 19 | |
| 20 | #include <sound/core.h> |
| 21 | |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 22 | #include "driver.h" |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 23 | #include "dumprequest.h" |
| 24 | |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 25 | /* |
| 26 | PODxt Live interfaces |
| 27 | */ |
| 28 | #define PODXTLIVE_INTERFACE_POD 0 |
| 29 | #define PODXTLIVE_INTERFACE_VARIAX 1 |
| 30 | |
| 31 | /* |
| 32 | Locate name in binary program dump |
| 33 | */ |
| 34 | #define POD_NAME_OFFSET 0 |
| 35 | #define POD_NAME_LENGTH 16 |
| 36 | |
| 37 | /* |
| 38 | Other constants |
| 39 | */ |
| 40 | #define POD_CONTROL_SIZE 0x80 |
| 41 | #define POD_BUFSIZE_DUMPREQ 7 |
Markus Grabner | e1a164d | 2010-08-23 01:08:25 +0200 | [diff] [blame] | 42 | #define POD_STARTUP_DELAY 1000 |
| 43 | |
| 44 | /* |
| 45 | Stages of POD startup procedure |
| 46 | */ |
| 47 | enum { |
| 48 | POD_STARTUP_INIT = 1, |
| 49 | POD_STARTUP_DUMPREQ, |
| 50 | POD_STARTUP_VERSIONREQ, |
| 51 | POD_STARTUP_WORKQUEUE, |
| 52 | POD_STARTUP_SETUP, |
| 53 | POD_STARTUP_LAST = POD_STARTUP_SETUP - 1 |
| 54 | }; |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 55 | |
| 56 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 57 | Data structure for values that need to be requested explicitly. |
| 58 | This is the case for system and tuner settings. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 59 | */ |
Greg Kroah-Hartman | a49e483 | 2009-02-27 21:09:55 -0800 | [diff] [blame] | 60 | struct ValueWait { |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 61 | int value; |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 62 | wait_queue_head_t wait; |
| 63 | }; |
| 64 | |
| 65 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 66 | Binary PODxt Pro program dump |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 67 | */ |
| 68 | struct pod_program { |
| 69 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 70 | Header information (including program name). |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 71 | */ |
| 72 | unsigned char header[0x20]; |
| 73 | |
| 74 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 75 | Program parameters. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 76 | */ |
| 77 | unsigned char control[POD_CONTROL_SIZE]; |
| 78 | }; |
| 79 | |
| 80 | struct usb_line6_pod { |
| 81 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 82 | Generic Line6 USB data. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 83 | */ |
| 84 | struct usb_line6 line6; |
| 85 | |
| 86 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 87 | Dump request structure. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 88 | */ |
| 89 | struct line6_dump_request dumpreq; |
| 90 | |
| 91 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 92 | Current program number. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 93 | */ |
| 94 | unsigned char channel_num; |
| 95 | |
| 96 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 97 | Current program settings. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 98 | */ |
| 99 | struct pod_program prog_data; |
| 100 | |
| 101 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 102 | Buffer for data retrieved from or to be stored on PODxt Pro. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 103 | */ |
| 104 | struct pod_program prog_data_buf; |
| 105 | |
| 106 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 107 | Tuner mute mode. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 108 | */ |
| 109 | struct ValueWait tuner_mute; |
| 110 | |
| 111 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 112 | Tuner base frequency (typically 440Hz). |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 113 | */ |
| 114 | struct ValueWait tuner_freq; |
| 115 | |
| 116 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 117 | Note received from tuner. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 118 | */ |
| 119 | struct ValueWait tuner_note; |
| 120 | |
| 121 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 122 | Pitch value received from tuner. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 123 | */ |
| 124 | struct ValueWait tuner_pitch; |
| 125 | |
| 126 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 127 | Instrument monitor level. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 128 | */ |
| 129 | struct ValueWait monitor_level; |
| 130 | |
| 131 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 132 | Audio routing mode. |
| 133 | 0: send processed guitar |
| 134 | 1: send clean guitar |
| 135 | 2: send clean guitar re-amp playback |
| 136 | 3: send re-amp playback |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 137 | */ |
| 138 | struct ValueWait routing; |
| 139 | |
| 140 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 141 | Wait for audio clipping event. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 142 | */ |
| 143 | struct ValueWait clipping; |
| 144 | |
| 145 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 146 | Timer for device initializaton. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 147 | */ |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 148 | struct timer_list startup_timer; |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 149 | |
| 150 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 151 | Work handler for device initializaton. |
| 152 | */ |
| 153 | struct work_struct startup_work; |
| 154 | |
| 155 | /** |
| 156 | Current progress in startup procedure. |
| 157 | */ |
| 158 | int startup_progress; |
| 159 | |
| 160 | /** |
| 161 | Dirty flags for access to parameter data. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 162 | */ |
| 163 | unsigned long param_dirty[POD_CONTROL_SIZE / sizeof(unsigned long)]; |
| 164 | |
| 165 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 166 | Some atomic flags. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 167 | */ |
| 168 | unsigned long atomic_flags; |
| 169 | |
| 170 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 171 | Serial number of device. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 172 | */ |
| 173 | int serial_number; |
| 174 | |
| 175 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 176 | Firmware version (x 100). |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 177 | */ |
| 178 | int firmware_version; |
| 179 | |
| 180 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 181 | Device ID. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 182 | */ |
| 183 | int device_id; |
| 184 | |
| 185 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 186 | Flag to indicate modification of current program settings. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 187 | */ |
| 188 | char dirty; |
| 189 | |
| 190 | /** |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 191 | Flag to enable MIDI postprocessing. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 192 | */ |
| 193 | char midi_postprocess; |
| 194 | }; |
| 195 | |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 196 | extern void line6_pod_disconnect(struct usb_interface *interface); |
Markus Grabner | e1a164d | 2010-08-23 01:08:25 +0200 | [diff] [blame] | 197 | extern int line6_pod_init(struct usb_interface *interface, |
| 198 | struct usb_line6_pod *pod); |
Markus Grabner | 1027f476 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 199 | extern void line6_pod_midi_postprocess(struct usb_line6_pod *pod, |
| 200 | unsigned char *data, int length); |
| 201 | extern void line6_pod_process_message(struct usb_line6_pod *pod); |
| 202 | extern void line6_pod_transmit_parameter(struct usb_line6_pod *pod, int param, |
Johannes Thumshirn | 5b9bd2a | 2012-06-27 21:25:57 +0200 | [diff] [blame^] | 203 | u8 value); |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 204 | |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 205 | #endif |