Erik - / Mbed 2 deprecated USBFileSystem_RAMDISK_HelloWorld

RAMDisk example for the USBFileSystem

Dependencies:   mbed USBFileSystem

Fork of USBFileSystem_RAMDISK_HelloWorld by Erik -

USBDevice/USBAudio/USBAudio.h@1:e1b0157ce547, 2013-07-30 (annotated)

Committer:
Sissors
Date:
Tue Jul 30 18:27:18 2013 +0000
Revision:
1:e1b0157ce547
Memory leaks -_-

Who changed what in which revision?

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