Piotr Woźniak / Mbed 2 deprecated KL46Z-Lab2_fullll

blablabla

Dependencies:   MAG3110 MMA8451Q SLCD- TSI USBDevice mbed

USBDevice/USBAudio/USBAudio.h@0:339b7abfa147, 2014-04-16 (annotated)

Committer:
Osator
Date:
Wed Apr 16 12:20:00 2014 +0000
Revision:
0:339b7abfa147
blablabla

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Osator 0:339b7abfa147 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
Osator 0:339b7abfa147 2 *
Osator 0:339b7abfa147 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Osator 0:339b7abfa147 4 * and associated documentation files (the "Software"), to deal in the Software without
Osator 0:339b7abfa147 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
Osator 0:339b7abfa147 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
Osator 0:339b7abfa147 7 * Software is furnished to do so, subject to the following conditions:
Osator 0:339b7abfa147 8 *
Osator 0:339b7abfa147 9 * The above copyright notice and this permission notice shall be included in all copies or
Osator 0:339b7abfa147 10 * substantial portions of the Software.
Osator 0:339b7abfa147 11 *
Osator 0:339b7abfa147 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Osator 0:339b7abfa147 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Osator 0:339b7abfa147 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Osator 0:339b7abfa147 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Osator 0:339b7abfa147 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Osator 0:339b7abfa147 17 */
Osator 0:339b7abfa147 18
Osator 0:339b7abfa147 19 #ifndef USBAudio_H
Osator 0:339b7abfa147 20 #define USBAudio_H
Osator 0:339b7abfa147 21
Osator 0:339b7abfa147 22 /* These headers are included for child class. */
Osator 0:339b7abfa147 23 #include "USBEndpoints.h"
Osator 0:339b7abfa147 24 #include "USBDescriptor.h"
Osator 0:339b7abfa147 25 #include "USBDevice_Types.h"
Osator 0:339b7abfa147 26
Osator 0:339b7abfa147 27 #include "USBDevice.h"
Osator 0:339b7abfa147 28
Osator 0:339b7abfa147 29
Osator 0:339b7abfa147 30 /**
Osator 0:339b7abfa147 31 * USBAudio example
Osator 0:339b7abfa147 32 *
Osator 0:339b7abfa147 33 * @code
Osator 0:339b7abfa147 34 * #include "mbed.h"
Osator 0:339b7abfa147 35 * #include "USBAudio.h"
Osator 0:339b7abfa147 36 *
Osator 0:339b7abfa147 37 * Serial pc(USBTX, USBRX);
Osator 0:339b7abfa147 38 *
Osator 0:339b7abfa147 39 * // frequency: 48 kHz
Osator 0:339b7abfa147 40 * #define FREQ 48000
Osator 0:339b7abfa147 41 *
Osator 0:339b7abfa147 42 * // 1 channel: mono
Osator 0:339b7abfa147 43 * #define NB_CHA 1
Osator 0:339b7abfa147 44 *
Osator 0:339b7abfa147 45 * // length of an audio packet: each ms, we receive 48 * 16bits ->48 * 2 bytes. as there is one channel, the length will be 48 * 2 * 1
Osator 0:339b7abfa147 46 * #define AUDIO_LENGTH_PACKET 48 * 2 * 1
Osator 0:339b7abfa147 47 *
Osator 0:339b7abfa147 48 * // USBAudio
Osator 0:339b7abfa147 49 * USBAudio audio(FREQ, NB_CHA);
Osator 0:339b7abfa147 50 *
Osator 0:339b7abfa147 51 * int main() {
Osator 0:339b7abfa147 52 * int16_t buf[AUDIO_LENGTH_PACKET/2];
Osator 0:339b7abfa147 53 *
Osator 0:339b7abfa147 54 * while (1) {
Osator 0:339b7abfa147 55 * // read an audio packet
Osator 0:339b7abfa147 56 * audio.read((uint8_t *)buf);
Osator 0:339b7abfa147 57 *
Osator 0:339b7abfa147 58 *
Osator 0:339b7abfa147 59 * // print packet received
Osator 0:339b7abfa147 60 * pc.printf("recv: ");
Osator 0:339b7abfa147 61 * for(int i = 0; i < AUDIO_LENGTH_PACKET/2; i++) {
Osator 0:339b7abfa147 62 * pc.printf("%d ", buf[i]);
Osator 0:339b7abfa147 63 * }
Osator 0:339b7abfa147 64 * pc.printf("\r\n");
Osator 0:339b7abfa147 65 * }
Osator 0:339b7abfa147 66 * }
Osator 0:339b7abfa147 67 * @endcode
Osator 0:339b7abfa147 68 */
Osator 0:339b7abfa147 69 class USBAudio: public USBDevice {
Osator 0:339b7abfa147 70 public:
Osator 0:339b7abfa147 71
Osator 0:339b7abfa147 72 /**
Osator 0:339b7abfa147 73 * Constructor
Osator 0:339b7abfa147 74 *
Osator 0:339b7abfa147 75 * @param frequency_in frequency in Hz (default: 48000)
Osator 0:339b7abfa147 76 * @param channel_nb_in channel number (1 or 2) (default: 1)
Osator 0:339b7abfa147 77 * @param frequency_out frequency in Hz (default: 8000)
Osator 0:339b7abfa147 78 * @param channel_nb_out_in channel number (1 or 2) (default: 1)
Osator 0:339b7abfa147 79 * @param vendor_id Your vendor_id
Osator 0:339b7abfa147 80 * @param product_id Your product_id
Osator 0:339b7abfa147 81 * @param product_release Your preoduct_release
Osator 0:339b7abfa147 82 */
Osator 0:339b7abfa147 83 USBAudio(uint32_t frequency_in = 48000, uint8_t channel_nb_in = 1, uint32_t frequency_out = 8000, uint8_t channel_nb_out = 1, uint16_t vendor_id = 0x7bb8, uint16_t product_id = 0x1111, uint16_t product_release = 0x0100);
Osator 0:339b7abfa147 84
Osator 0:339b7abfa147 85 /**
Osator 0:339b7abfa147 86 * Get current volume between 0.0 and 1.0
Osator 0:339b7abfa147 87 *
Osator 0:339b7abfa147 88 * @returns volume
Osator 0:339b7abfa147 89 */
Osator 0:339b7abfa147 90 float getVolume();
Osator 0:339b7abfa147 91
Osator 0:339b7abfa147 92 /**
Osator 0:339b7abfa147 93 * Read an audio packet. During a frame, only a single reading (you can't write and read an audio packet during the same frame)can be done using this method. Warning: Blocking
Osator 0:339b7abfa147 94 *
Osator 0:339b7abfa147 95 * @param buf pointer on a buffer which will be filled with an audio packet
Osator 0:339b7abfa147 96 *
Osator 0:339b7abfa147 97 * @returns true if successfull
Osator 0:339b7abfa147 98 */
Osator 0:339b7abfa147 99 bool read(uint8_t * buf);
Osator 0:339b7abfa147 100
Osator 0:339b7abfa147 101 /**
Osator 0:339b7abfa147 102 * Try to read an audio packet. During a frame, only a single reading (you can't write and read an audio packet during the same frame)can be done using this method. Warning: Non Blocking
Osator 0:339b7abfa147 103 *
Osator 0:339b7abfa147 104 * @param buf pointer on a buffer which will be filled if an audio packet is available
Osator 0:339b7abfa147 105 *
Osator 0:339b7abfa147 106 * @returns true if successfull
Osator 0:339b7abfa147 107 */
Osator 0:339b7abfa147 108 bool readNB(uint8_t * buf);
Osator 0:339b7abfa147 109
Osator 0:339b7abfa147 110 /**
Osator 0:339b7abfa147 111 * Write an audio packet. During a frame, only a single writing (you can't write and read an audio packet during the same frame)can be done using this method.
Osator 0:339b7abfa147 112 *
Osator 0:339b7abfa147 113 * @param buf pointer on the audio packet which will be sent
Osator 0:339b7abfa147 114 * @returns true if successful
Osator 0:339b7abfa147 115 */
Osator 0:339b7abfa147 116 bool write(uint8_t * buf);
Osator 0:339b7abfa147 117
Osator 0:339b7abfa147 118 /**
Osator 0:339b7abfa147 119 * Write and read an audio packet at the same time (on the same frame)
Osator 0:339b7abfa147 120 *
Osator 0:339b7abfa147 121 * @param buf_read pointer on a buffer which will be filled with an audio packet
Osator 0:339b7abfa147 122 * @param buf_write pointer on the audio packet which will be sent
Osator 0:339b7abfa147 123 * @returns true if successful
Osator 0:339b7abfa147 124 */
Osator 0:339b7abfa147 125 bool readWrite(uint8_t * buf_read, uint8_t * buf_write);
Osator 0:339b7abfa147 126
Osator 0:339b7abfa147 127
Osator 0:339b7abfa147 128 /** attach a handler to update the volume
Osator 0:339b7abfa147 129 *
Osator 0:339b7abfa147 130 * @param function Function to attach
Osator 0:339b7abfa147 131 *
Osator 0:339b7abfa147 132 */
Osator 0:339b7abfa147 133 void attach(void(*fptr)(void)) {
Osator 0:339b7abfa147 134 updateVol.attach(fptr);
Osator 0:339b7abfa147 135 }
Osator 0:339b7abfa147 136
Osator 0:339b7abfa147 137 /** Attach a nonstatic void/void member function to update the volume
Osator 0:339b7abfa147 138 *
Osator 0:339b7abfa147 139 * @param tptr Object pointer
Osator 0:339b7abfa147 140 * @param mptr Member function pointer
Osator 0:339b7abfa147 141 *
Osator 0:339b7abfa147 142 */
Osator 0:339b7abfa147 143 template<typename T>
Osator 0:339b7abfa147 144 void attach(T *tptr, void(T::*mptr)(void)) {
Osator 0:339b7abfa147 145 updateVol.attach(tptr, mptr);
Osator 0:339b7abfa147 146 }
Osator 0:339b7abfa147 147
Osator 0:339b7abfa147 148
Osator 0:339b7abfa147 149 protected:
Osator 0:339b7abfa147 150
Osator 0:339b7abfa147 151 /*
Osator 0:339b7abfa147 152 * Called by USBDevice layer. Set configuration of the device.
Osator 0:339b7abfa147 153 * For instance, you can add all endpoints that you need on this function.
Osator 0:339b7abfa147 154 *
Osator 0:339b7abfa147 155 * @param configuration Number of the configuration
Osator 0:339b7abfa147 156 * @returns true if class handles this request
Osator 0:339b7abfa147 157 */
Osator 0:339b7abfa147 158 virtual bool USBCallback_setConfiguration(uint8_t configuration);
Osator 0:339b7abfa147 159
Osator 0:339b7abfa147 160 /*
Osator 0:339b7abfa147 161 * Called by USBDevice on Endpoint0 request. Warning: Called in ISR context
Osator 0:339b7abfa147 162 * This is used to handle extensions to standard requests
Osator 0:339b7abfa147 163 * and class specific requests
Osator 0:339b7abfa147 164 *
Osator 0:339b7abfa147 165 * @returns true if class handles this request
Osator 0:339b7abfa147 166 */
Osator 0:339b7abfa147 167 virtual bool USBCallback_request();
Osator 0:339b7abfa147 168
Osator 0:339b7abfa147 169 /*
Osator 0:339b7abfa147 170 * Get string product descriptor
Osator 0:339b7abfa147 171 *
Osator 0:339b7abfa147 172 * @returns pointer to the string product descriptor
Osator 0:339b7abfa147 173 */
Osator 0:339b7abfa147 174 virtual uint8_t * stringIproductDesc();
Osator 0:339b7abfa147 175
Osator 0:339b7abfa147 176 /*
Osator 0:339b7abfa147 177 * Get string interface descriptor
Osator 0:339b7abfa147 178 *
Osator 0:339b7abfa147 179 * @returns pointer to the string interface descriptor
Osator 0:339b7abfa147 180 */
Osator 0:339b7abfa147 181 virtual uint8_t * stringIinterfaceDesc();
Osator 0:339b7abfa147 182
Osator 0:339b7abfa147 183 /*
Osator 0:339b7abfa147 184 * Get configuration descriptor
Osator 0:339b7abfa147 185 *
Osator 0:339b7abfa147 186 * @returns pointer to the configuration descriptor
Osator 0:339b7abfa147 187 */
Osator 0:339b7abfa147 188 virtual uint8_t * configurationDesc();
Osator 0:339b7abfa147 189
Osator 0:339b7abfa147 190 /*
Osator 0:339b7abfa147 191 * Called by USBDevice layer. Set interface/alternate of the device.
Osator 0:339b7abfa147 192 *
Osator 0:339b7abfa147 193 * @param interface Number of the interface to be configured
Osator 0:339b7abfa147 194 * @param alternate Number of the alternate to be configured
Osator 0:339b7abfa147 195 * @returns true if class handles this request
Osator 0:339b7abfa147 196 */
Osator 0:339b7abfa147 197 virtual bool USBCallback_setInterface(uint16_t interface, uint8_t alternate);
Osator 0:339b7abfa147 198
Osator 0:339b7abfa147 199 /*
Osator 0:339b7abfa147 200 * Called by USBDevice on Endpoint0 request completion
Osator 0:339b7abfa147 201 * if the 'notify' flag has been set to true. Warning: Called in ISR context
Osator 0:339b7abfa147 202 *
Osator 0:339b7abfa147 203 * In this case it is used to indicate that a HID report has
Osator 0:339b7abfa147 204 * been received from the host on endpoint 0
Osator 0:339b7abfa147 205 *
Osator 0:339b7abfa147 206 * @param buf buffer received on endpoint 0
Osator 0:339b7abfa147 207 * @param length length of this buffer
Osator 0:339b7abfa147 208 */
Osator 0:339b7abfa147 209 virtual void USBCallback_requestCompleted(uint8_t * buf, uint32_t length);
Osator 0:339b7abfa147 210
Osator 0:339b7abfa147 211 /*
Osator 0:339b7abfa147 212 * Callback called on each Start of Frame event
Osator 0:339b7abfa147 213 */
Osator 0:339b7abfa147 214 virtual void SOF(int frameNumber);
Osator 0:339b7abfa147 215
Osator 0:339b7abfa147 216 /*
Osator 0:339b7abfa147 217 * Callback called when a packet is received
Osator 0:339b7abfa147 218 */
Osator 0:339b7abfa147 219 virtual bool EP3_OUT_callback();
Osator 0:339b7abfa147 220
Osator 0:339b7abfa147 221 /*
Osator 0:339b7abfa147 222 * Callback called when a packet has been sent
Osator 0:339b7abfa147 223 */
Osator 0:339b7abfa147 224 virtual bool EP3_IN_callback();
Osator 0:339b7abfa147 225
Osator 0:339b7abfa147 226 private:
Osator 0:339b7abfa147 227
Osator 0:339b7abfa147 228 // stream available ?
Osator 0:339b7abfa147 229 volatile bool available;
Osator 0:339b7abfa147 230
Osator 0:339b7abfa147 231 // interrupt OUT has been received
Osator 0:339b7abfa147 232 volatile bool interruptOUT;
Osator 0:339b7abfa147 233
Osator 0:339b7abfa147 234 // interrupt IN has been received
Osator 0:339b7abfa147 235 volatile bool interruptIN;
Osator 0:339b7abfa147 236
Osator 0:339b7abfa147 237 // audio packet has been written
Osator 0:339b7abfa147 238 volatile bool writeIN;
Osator 0:339b7abfa147 239
Osator 0:339b7abfa147 240 // FREQ
Osator 0:339b7abfa147 241 uint32_t FREQ_OUT;
Osator 0:339b7abfa147 242 uint32_t FREQ_IN;
Osator 0:339b7abfa147 243
Osator 0:339b7abfa147 244 // size of the maximum packet for the isochronous endpoint
Osator 0:339b7abfa147 245 uint32_t PACKET_SIZE_ISO_IN;
Osator 0:339b7abfa147 246 uint32_t PACKET_SIZE_ISO_OUT;
Osator 0:339b7abfa147 247
Osator 0:339b7abfa147 248 // mono, stereo,...
Osator 0:339b7abfa147 249 uint8_t channel_nb_in;
Osator 0:339b7abfa147 250 uint8_t channel_nb_out;
Osator 0:339b7abfa147 251
Osator 0:339b7abfa147 252 // channel config: master, left, right
Osator 0:339b7abfa147 253 uint8_t channel_config_in;
Osator 0:339b7abfa147 254 uint8_t channel_config_out;
Osator 0:339b7abfa147 255
Osator 0:339b7abfa147 256 // mute state
Osator 0:339b7abfa147 257 uint8_t mute;
Osator 0:339b7abfa147 258
Osator 0:339b7abfa147 259 // Volume Current Value
Osator 0:339b7abfa147 260 uint16_t volCur;
Osator 0:339b7abfa147 261
Osator 0:339b7abfa147 262 // Volume Minimum Value
Osator 0:339b7abfa147 263 uint16_t volMin;
Osator 0:339b7abfa147 264
Osator 0:339b7abfa147 265 // Volume Maximum Value
Osator 0:339b7abfa147 266 uint16_t volMax;
Osator 0:339b7abfa147 267
Osator 0:339b7abfa147 268 // Volume Resolution
Osator 0:339b7abfa147 269 uint16_t volRes;
Osator 0:339b7abfa147 270
Osator 0:339b7abfa147 271 // Buffer containing one audio packet (to be read)
Osator 0:339b7abfa147 272 volatile uint8_t * buf_stream_in;
Osator 0:339b7abfa147 273
Osator 0:339b7abfa147 274 // Buffer containing one audio packet (to be written)
Osator 0:339b7abfa147 275 volatile uint8_t * buf_stream_out;
Osator 0:339b7abfa147 276
Osator 0:339b7abfa147 277 // callback to update volume
Osator 0:339b7abfa147 278 FunctionPointer updateVol;
Osator 0:339b7abfa147 279
Osator 0:339b7abfa147 280 // boolean showing that the SOF handler has been called. Useful for readNB.
Osator 0:339b7abfa147 281 volatile bool SOF_handler;
Osator 0:339b7abfa147 282
Osator 0:339b7abfa147 283 volatile float volume;
Osator 0:339b7abfa147 284
Osator 0:339b7abfa147 285 };
Osator 0:339b7abfa147 286
Osator 0:339b7abfa147 287 #endif