Demo program for library named SD_PlayerSkeleton of SD card player skeleton. SD カードプレーヤのための骨組みとして使うためのライブラリ SD_PlayerSkeleton の使用例.このプログラムについては,CQ出版社インターフェース誌 2018年7月号で解説している.

Dependencies:   F746_GUI F746_SAI_IO SD_PlayerSkeleton

Committer:
MikamiUitOpen
Date:
Sun Apr 09 12:44:17 2017 +0000
Revision:
19:3c3833ec00d2
Parent:
2:cf42e62a97dc
20

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MikamiUitOpen 2:cf42e62a97dc 1 /* mbed Microcontroller Library
MikamiUitOpen 2:cf42e62a97dc 2 * Copyright (c) 2006-2013 ARM Limited
MikamiUitOpen 2:cf42e62a97dc 3 *
MikamiUitOpen 2:cf42e62a97dc 4 * Licensed under the Apache License, Version 2.0 (the "License");
MikamiUitOpen 2:cf42e62a97dc 5 * you may not use this file except in compliance with the License.
MikamiUitOpen 2:cf42e62a97dc 6 * You may obtain a copy of the License at
MikamiUitOpen 2:cf42e62a97dc 7 *
MikamiUitOpen 2:cf42e62a97dc 8 * http://www.apache.org/licenses/LICENSE-2.0
MikamiUitOpen 2:cf42e62a97dc 9 *
MikamiUitOpen 2:cf42e62a97dc 10 * Unless required by applicable law or agreed to in writing, software
MikamiUitOpen 2:cf42e62a97dc 11 * distributed under the License is distributed on an "AS IS" BASIS,
MikamiUitOpen 2:cf42e62a97dc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
MikamiUitOpen 2:cf42e62a97dc 13 * See the License for the specific language governing permissions and
MikamiUitOpen 2:cf42e62a97dc 14 * limitations under the License.
MikamiUitOpen 2:cf42e62a97dc 15 */
MikamiUitOpen 2:cf42e62a97dc 16 #ifndef MBED_SERIALBASE_H
MikamiUitOpen 2:cf42e62a97dc 17 #define MBED_SERIALBASE_H
MikamiUitOpen 2:cf42e62a97dc 18
MikamiUitOpen 2:cf42e62a97dc 19 #include "platform.h"
MikamiUitOpen 2:cf42e62a97dc 20
MikamiUitOpen 2:cf42e62a97dc 21 #if DEVICE_SERIAL
MikamiUitOpen 2:cf42e62a97dc 22
MikamiUitOpen 2:cf42e62a97dc 23 #include "Stream.h"
MikamiUitOpen 2:cf42e62a97dc 24 #include "FunctionPointer.h"
MikamiUitOpen 2:cf42e62a97dc 25 #include "serial_api.h"
MikamiUitOpen 2:cf42e62a97dc 26
MikamiUitOpen 2:cf42e62a97dc 27 #if DEVICE_SERIAL_ASYNCH
MikamiUitOpen 2:cf42e62a97dc 28 #include "CThunk.h"
MikamiUitOpen 2:cf42e62a97dc 29 #include "dma_api.h"
MikamiUitOpen 2:cf42e62a97dc 30 #endif
MikamiUitOpen 2:cf42e62a97dc 31
MikamiUitOpen 2:cf42e62a97dc 32 namespace mbed {
MikamiUitOpen 2:cf42e62a97dc 33
MikamiUitOpen 2:cf42e62a97dc 34 /** A base class for serial port implementations
MikamiUitOpen 2:cf42e62a97dc 35 * Can't be instantiated directly (use Serial or RawSerial)
MikamiUitOpen 2:cf42e62a97dc 36 */
MikamiUitOpen 2:cf42e62a97dc 37 class SerialBase {
MikamiUitOpen 2:cf42e62a97dc 38
MikamiUitOpen 2:cf42e62a97dc 39 public:
MikamiUitOpen 2:cf42e62a97dc 40 /** Set the baud rate of the serial port
MikamiUitOpen 2:cf42e62a97dc 41 *
MikamiUitOpen 2:cf42e62a97dc 42 * @param baudrate The baudrate of the serial port (default = 9600).
MikamiUitOpen 2:cf42e62a97dc 43 */
MikamiUitOpen 2:cf42e62a97dc 44 void baud(int baudrate);
MikamiUitOpen 2:cf42e62a97dc 45
MikamiUitOpen 2:cf42e62a97dc 46 enum Parity {
MikamiUitOpen 2:cf42e62a97dc 47 None = 0,
MikamiUitOpen 2:cf42e62a97dc 48 Odd,
MikamiUitOpen 2:cf42e62a97dc 49 Even,
MikamiUitOpen 2:cf42e62a97dc 50 Forced1,
MikamiUitOpen 2:cf42e62a97dc 51 Forced0
MikamiUitOpen 2:cf42e62a97dc 52 };
MikamiUitOpen 2:cf42e62a97dc 53
MikamiUitOpen 2:cf42e62a97dc 54 enum IrqType {
MikamiUitOpen 2:cf42e62a97dc 55 RxIrq = 0,
MikamiUitOpen 2:cf42e62a97dc 56 TxIrq
MikamiUitOpen 2:cf42e62a97dc 57 };
MikamiUitOpen 2:cf42e62a97dc 58
MikamiUitOpen 2:cf42e62a97dc 59 enum Flow {
MikamiUitOpen 2:cf42e62a97dc 60 Disabled = 0,
MikamiUitOpen 2:cf42e62a97dc 61 RTS,
MikamiUitOpen 2:cf42e62a97dc 62 CTS,
MikamiUitOpen 2:cf42e62a97dc 63 RTSCTS
MikamiUitOpen 2:cf42e62a97dc 64 };
MikamiUitOpen 2:cf42e62a97dc 65
MikamiUitOpen 2:cf42e62a97dc 66 /** Set the transmission format used by the serial port
MikamiUitOpen 2:cf42e62a97dc 67 *
MikamiUitOpen 2:cf42e62a97dc 68 * @param bits The number of bits in a word (5-8; default = 8)
MikamiUitOpen 2:cf42e62a97dc 69 * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
MikamiUitOpen 2:cf42e62a97dc 70 * @param stop The number of stop bits (1 or 2; default = 1)
MikamiUitOpen 2:cf42e62a97dc 71 */
MikamiUitOpen 2:cf42e62a97dc 72 void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);
MikamiUitOpen 2:cf42e62a97dc 73
MikamiUitOpen 2:cf42e62a97dc 74 /** Determine if there is a character available to read
MikamiUitOpen 2:cf42e62a97dc 75 *
MikamiUitOpen 2:cf42e62a97dc 76 * @returns
MikamiUitOpen 2:cf42e62a97dc 77 * 1 if there is a character available to read,
MikamiUitOpen 2:cf42e62a97dc 78 * 0 otherwise
MikamiUitOpen 2:cf42e62a97dc 79 */
MikamiUitOpen 2:cf42e62a97dc 80 int readable();
MikamiUitOpen 2:cf42e62a97dc 81
MikamiUitOpen 2:cf42e62a97dc 82 /** Determine if there is space available to write a character
MikamiUitOpen 2:cf42e62a97dc 83 *
MikamiUitOpen 2:cf42e62a97dc 84 * @returns
MikamiUitOpen 2:cf42e62a97dc 85 * 1 if there is space to write a character,
MikamiUitOpen 2:cf42e62a97dc 86 * 0 otherwise
MikamiUitOpen 2:cf42e62a97dc 87 */
MikamiUitOpen 2:cf42e62a97dc 88 int writeable();
MikamiUitOpen 2:cf42e62a97dc 89
MikamiUitOpen 2:cf42e62a97dc 90 /** Attach a function to call whenever a serial interrupt is generated
MikamiUitOpen 2:cf42e62a97dc 91 *
MikamiUitOpen 2:cf42e62a97dc 92 * @param fptr A pointer to a void function, or 0 to set as none
MikamiUitOpen 2:cf42e62a97dc 93 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
MikamiUitOpen 2:cf42e62a97dc 94 */
MikamiUitOpen 2:cf42e62a97dc 95 void attach(void (*fptr)(void), IrqType type=RxIrq);
MikamiUitOpen 2:cf42e62a97dc 96
MikamiUitOpen 2:cf42e62a97dc 97 /** Attach a member function to call whenever a serial interrupt is generated
MikamiUitOpen 2:cf42e62a97dc 98 *
MikamiUitOpen 2:cf42e62a97dc 99 * @param tptr pointer to the object to call the member function on
MikamiUitOpen 2:cf42e62a97dc 100 * @param mptr pointer to the member function to be called
MikamiUitOpen 2:cf42e62a97dc 101 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
MikamiUitOpen 2:cf42e62a97dc 102 */
MikamiUitOpen 2:cf42e62a97dc 103 template<typename T>
MikamiUitOpen 2:cf42e62a97dc 104 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
MikamiUitOpen 2:cf42e62a97dc 105 if((mptr != NULL) && (tptr != NULL)) {
MikamiUitOpen 2:cf42e62a97dc 106 _irq[type].attach(tptr, mptr);
MikamiUitOpen 2:cf42e62a97dc 107 serial_irq_set(&_serial, (SerialIrq)type, 1);
MikamiUitOpen 2:cf42e62a97dc 108 } else {
MikamiUitOpen 2:cf42e62a97dc 109 serial_irq_set(&_serial, (SerialIrq)type, 0);
MikamiUitOpen 2:cf42e62a97dc 110 }
MikamiUitOpen 2:cf42e62a97dc 111 }
MikamiUitOpen 2:cf42e62a97dc 112
MikamiUitOpen 2:cf42e62a97dc 113 /** Generate a break condition on the serial line
MikamiUitOpen 2:cf42e62a97dc 114 */
MikamiUitOpen 2:cf42e62a97dc 115 void send_break();
MikamiUitOpen 2:cf42e62a97dc 116
MikamiUitOpen 2:cf42e62a97dc 117 #if DEVICE_SERIAL_FC
MikamiUitOpen 2:cf42e62a97dc 118 /** Set the flow control type on the serial port
MikamiUitOpen 2:cf42e62a97dc 119 *
MikamiUitOpen 2:cf42e62a97dc 120 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
MikamiUitOpen 2:cf42e62a97dc 121 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
MikamiUitOpen 2:cf42e62a97dc 122 * @param flow2 the second flow control pin (CTS for RTSCTS)
MikamiUitOpen 2:cf42e62a97dc 123 */
MikamiUitOpen 2:cf42e62a97dc 124 void set_flow_control(Flow type, PinName flow1=NC, PinName flow2=NC);
MikamiUitOpen 2:cf42e62a97dc 125 #endif
MikamiUitOpen 2:cf42e62a97dc 126
MikamiUitOpen 2:cf42e62a97dc 127 static void _irq_handler(uint32_t id, SerialIrq irq_type);
MikamiUitOpen 2:cf42e62a97dc 128
MikamiUitOpen 2:cf42e62a97dc 129 #if DEVICE_SERIAL_ASYNCH
MikamiUitOpen 2:cf42e62a97dc 130
MikamiUitOpen 2:cf42e62a97dc 131 /** Begin asynchronous write using 8bit buffer. The completition invokes registered TX event callback
MikamiUitOpen 2:cf42e62a97dc 132 *
MikamiUitOpen 2:cf42e62a97dc 133 * @param buffer The buffer where received data will be stored
MikamiUitOpen 2:cf42e62a97dc 134 * @param length The buffer length in bytes
MikamiUitOpen 2:cf42e62a97dc 135 * @param callback The event callback function
MikamiUitOpen 2:cf42e62a97dc 136 * @param event The logical OR of TX events
MikamiUitOpen 2:cf42e62a97dc 137 */
MikamiUitOpen 2:cf42e62a97dc 138 int write(const uint8_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_TX_COMPLETE);
MikamiUitOpen 2:cf42e62a97dc 139
MikamiUitOpen 2:cf42e62a97dc 140 /** Begin asynchronous write using 16bit buffer. The completition invokes registered TX event callback
MikamiUitOpen 2:cf42e62a97dc 141 *
MikamiUitOpen 2:cf42e62a97dc 142 * @param buffer The buffer where received data will be stored
MikamiUitOpen 2:cf42e62a97dc 143 * @param length The buffer length in bytes
MikamiUitOpen 2:cf42e62a97dc 144 * @param callback The event callback function
MikamiUitOpen 2:cf42e62a97dc 145 * @param event The logical OR of TX events
MikamiUitOpen 2:cf42e62a97dc 146 */
MikamiUitOpen 2:cf42e62a97dc 147 int write(const uint16_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_TX_COMPLETE);
MikamiUitOpen 2:cf42e62a97dc 148
MikamiUitOpen 2:cf42e62a97dc 149 /** Abort the on-going write transfer
MikamiUitOpen 2:cf42e62a97dc 150 */
MikamiUitOpen 2:cf42e62a97dc 151 void abort_write();
MikamiUitOpen 2:cf42e62a97dc 152
MikamiUitOpen 2:cf42e62a97dc 153 /** Begin asynchronous reading using 8bit buffer. The completition invokes registred RX event callback.
MikamiUitOpen 2:cf42e62a97dc 154 *
MikamiUitOpen 2:cf42e62a97dc 155 * @param buffer The buffer where received data will be stored
MikamiUitOpen 2:cf42e62a97dc 156 * @param length The buffer length in bytes
MikamiUitOpen 2:cf42e62a97dc 157 * @param callback The event callback function
MikamiUitOpen 2:cf42e62a97dc 158 * @param event The logical OR of RX events
MikamiUitOpen 2:cf42e62a97dc 159 * @param char_match The matching character
MikamiUitOpen 2:cf42e62a97dc 160 */
MikamiUitOpen 2:cf42e62a97dc 161 int read(uint8_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH);
MikamiUitOpen 2:cf42e62a97dc 162
MikamiUitOpen 2:cf42e62a97dc 163 /** Begin asynchronous reading using 16bit buffer. The completition invokes registred RX event callback.
MikamiUitOpen 2:cf42e62a97dc 164 *
MikamiUitOpen 2:cf42e62a97dc 165 * @param buffer The buffer where received data will be stored
MikamiUitOpen 2:cf42e62a97dc 166 * @param length The buffer length in bytes
MikamiUitOpen 2:cf42e62a97dc 167 * @param callback The event callback function
MikamiUitOpen 2:cf42e62a97dc 168 * @param event The logical OR of RX events
MikamiUitOpen 2:cf42e62a97dc 169 * @param char_match The matching character
MikamiUitOpen 2:cf42e62a97dc 170 */
MikamiUitOpen 2:cf42e62a97dc 171 int read(uint16_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH);
MikamiUitOpen 2:cf42e62a97dc 172
MikamiUitOpen 2:cf42e62a97dc 173 /** Abort the on-going read transfer
MikamiUitOpen 2:cf42e62a97dc 174 */
MikamiUitOpen 2:cf42e62a97dc 175 void abort_read();
MikamiUitOpen 2:cf42e62a97dc 176
MikamiUitOpen 2:cf42e62a97dc 177 /** Configure DMA usage suggestion for non-blocking TX transfers
MikamiUitOpen 2:cf42e62a97dc 178 *
MikamiUitOpen 2:cf42e62a97dc 179 * @param usage The usage DMA hint for peripheral
MikamiUitOpen 2:cf42e62a97dc 180 * @return Zero if the usage was set, -1 if a transaction is on-going
MikamiUitOpen 2:cf42e62a97dc 181 */
MikamiUitOpen 2:cf42e62a97dc 182 int set_dma_usage_tx(DMAUsage usage);
MikamiUitOpen 2:cf42e62a97dc 183
MikamiUitOpen 2:cf42e62a97dc 184 /** Configure DMA usage suggestion for non-blocking RX transfers
MikamiUitOpen 2:cf42e62a97dc 185 *
MikamiUitOpen 2:cf42e62a97dc 186 * @param usage The usage DMA hint for peripheral
MikamiUitOpen 2:cf42e62a97dc 187 * @return Zero if the usage was set, -1 if a transaction is on-going
MikamiUitOpen 2:cf42e62a97dc 188 */
MikamiUitOpen 2:cf42e62a97dc 189 int set_dma_usage_rx(DMAUsage usage);
MikamiUitOpen 2:cf42e62a97dc 190
MikamiUitOpen 2:cf42e62a97dc 191 protected:
MikamiUitOpen 2:cf42e62a97dc 192 void start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t& callback, int event, unsigned char char_match);
MikamiUitOpen 2:cf42e62a97dc 193 void start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t& callback, int event);
MikamiUitOpen 2:cf42e62a97dc 194 void interrupt_handler_asynch(void);
MikamiUitOpen 2:cf42e62a97dc 195 #endif
MikamiUitOpen 2:cf42e62a97dc 196
MikamiUitOpen 2:cf42e62a97dc 197 protected:
MikamiUitOpen 2:cf42e62a97dc 198 SerialBase(PinName tx, PinName rx);
MikamiUitOpen 2:cf42e62a97dc 199 virtual ~SerialBase() {
MikamiUitOpen 2:cf42e62a97dc 200 }
MikamiUitOpen 2:cf42e62a97dc 201
MikamiUitOpen 2:cf42e62a97dc 202 int _base_getc();
MikamiUitOpen 2:cf42e62a97dc 203 int _base_putc(int c);
MikamiUitOpen 2:cf42e62a97dc 204
MikamiUitOpen 2:cf42e62a97dc 205 #if DEVICE_SERIAL_ASYNCH
MikamiUitOpen 2:cf42e62a97dc 206 CThunk<SerialBase> _thunk_irq;
MikamiUitOpen 2:cf42e62a97dc 207 event_callback_t _tx_callback;
MikamiUitOpen 2:cf42e62a97dc 208 event_callback_t _rx_callback;
MikamiUitOpen 2:cf42e62a97dc 209 DMAUsage _tx_usage;
MikamiUitOpen 2:cf42e62a97dc 210 DMAUsage _rx_usage;
MikamiUitOpen 2:cf42e62a97dc 211 #endif
MikamiUitOpen 2:cf42e62a97dc 212
MikamiUitOpen 2:cf42e62a97dc 213 serial_t _serial;
MikamiUitOpen 2:cf42e62a97dc 214 FunctionPointer _irq[2];
MikamiUitOpen 2:cf42e62a97dc 215 int _baud;
MikamiUitOpen 2:cf42e62a97dc 216
MikamiUitOpen 2:cf42e62a97dc 217 };
MikamiUitOpen 2:cf42e62a97dc 218
MikamiUitOpen 2:cf42e62a97dc 219 } // namespace mbed
MikamiUitOpen 2:cf42e62a97dc 220
MikamiUitOpen 2:cf42e62a97dc 221 #endif
MikamiUitOpen 2:cf42e62a97dc 222
MikamiUitOpen 2:cf42e62a97dc 223 #endif