mbed official / USBDevice Featured

USB device stack

Dependents:   mbed-mX-USB-TEST1 USBMSD_SD_HID_HelloWorld HidTest MIDI_usb_bridge ... more

Legacy Warning

This is an mbed 2 library. To learn more about mbed OS 5, visit the docs.

Pull requests against this repository are no longer supported. Please raise against mbed OS 5 as documented above.

USBAudio/USBAudio.h@71:53949e6131f6, 2017-07-27 (annotated)

Committer:
Kojto
Date:
Thu Jul 27 12:14:04 2017 +0100
Revision:
71:53949e6131f6
Parent:
70:2c525a50f1b6 
Update libraries



Fixes the previous commmit, as some devices were not copied. USBDevice contains

now targets directory with all targets implementations

Who changed what in which revision?

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