Patrick Pollet / USBDevice

usb device

USBAudio/USBAudio.h@0:c1e89c49eae5, 2022-05-14 (annotated)

Committer:
ppo
Date:
Sat May 14 17:24:10 2022 +0000
Revision:
0:c1e89c49eae5
commit

Who changed what in which revision?

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