goma yam / USBDevice

USBDevice

Dependents:   QEI_X1_LCD_test3 macnica_test

USBAudio/USBAudio.h@0:2d8d0b73e1ff, 2013-04-18 (annotated)

Committer:
toucyy
Date:
Thu Apr 18 07:49:37 2013 +0000
Revision:
0:2d8d0b73e1ff
[mbed] converted /QEI_HelloWorld/USBDevice

Who changed what in which revision?

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