PHung Tung / DISCO-F746_WAV_PLAYER

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

SRC_STM32F7/api/SPISlave.h@0:8ede47d38d10, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:37:21 2019 +0000
Revision:
0:8ede47d38d10
SPKT

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:8ede47d38d10 1 /* mbed Microcontroller Library
phungductung 0:8ede47d38d10 2 * Copyright (c) 2006-2013 ARM Limited
phungductung 0:8ede47d38d10 3 *
phungductung 0:8ede47d38d10 4 * Licensed under the Apache License, Version 2.0 (the "License");
phungductung 0:8ede47d38d10 5 * you may not use this file except in compliance with the License.
phungductung 0:8ede47d38d10 6 * You may obtain a copy of the License at
phungductung 0:8ede47d38d10 7 *
phungductung 0:8ede47d38d10 8 * http://www.apache.org/licenses/LICENSE-2.0
phungductung 0:8ede47d38d10 9 *
phungductung 0:8ede47d38d10 10 * Unless required by applicable law or agreed to in writing, software
phungductung 0:8ede47d38d10 11 * distributed under the License is distributed on an "AS IS" BASIS,
phungductung 0:8ede47d38d10 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
phungductung 0:8ede47d38d10 13 * See the License for the specific language governing permissions and
phungductung 0:8ede47d38d10 14 * limitations under the License.
phungductung 0:8ede47d38d10 15 */
phungductung 0:8ede47d38d10 16 #ifndef MBED_SPISLAVE_H
phungductung 0:8ede47d38d10 17 #define MBED_SPISLAVE_H
phungductung 0:8ede47d38d10 18
phungductung 0:8ede47d38d10 19 #include "platform.h"
phungductung 0:8ede47d38d10 20
phungductung 0:8ede47d38d10 21 #if DEVICE_SPISLAVE
phungductung 0:8ede47d38d10 22
phungductung 0:8ede47d38d10 23 #include "spi_api.h"
phungductung 0:8ede47d38d10 24
phungductung 0:8ede47d38d10 25 namespace mbed {
phungductung 0:8ede47d38d10 26
phungductung 0:8ede47d38d10 27 /** A SPI slave, used for communicating with a SPI Master device
phungductung 0:8ede47d38d10 28 *
phungductung 0:8ede47d38d10 29 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
phungductung 0:8ede47d38d10 30 *
phungductung 0:8ede47d38d10 31 * Example:
phungductung 0:8ede47d38d10 32 * @code
phungductung 0:8ede47d38d10 33 * // Reply to a SPI master as slave
phungductung 0:8ede47d38d10 34 *
phungductung 0:8ede47d38d10 35 * #include "mbed.h"
phungductung 0:8ede47d38d10 36 *
phungductung 0:8ede47d38d10 37 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
phungductung 0:8ede47d38d10 38 *
phungductung 0:8ede47d38d10 39 * int main() {
phungductung 0:8ede47d38d10 40 * device.reply(0x00); // Prime SPI with first reply
phungductung 0:8ede47d38d10 41 * while(1) {
phungductung 0:8ede47d38d10 42 * if(device.receive()) {
phungductung 0:8ede47d38d10 43 * int v = device.read(); // Read byte from master
phungductung 0:8ede47d38d10 44 * v = (v + 1) % 0x100; // Add one to it, modulo 256
phungductung 0:8ede47d38d10 45 * device.reply(v); // Make this the next reply
phungductung 0:8ede47d38d10 46 * }
phungductung 0:8ede47d38d10 47 * }
phungductung 0:8ede47d38d10 48 * }
phungductung 0:8ede47d38d10 49 * @endcode
phungductung 0:8ede47d38d10 50 */
phungductung 0:8ede47d38d10 51 class SPISlave {
phungductung 0:8ede47d38d10 52
phungductung 0:8ede47d38d10 53 public:
phungductung 0:8ede47d38d10 54
phungductung 0:8ede47d38d10 55 /** Create a SPI slave connected to the specified pins
phungductung 0:8ede47d38d10 56 *
phungductung 0:8ede47d38d10 57 * mosi or miso can be specfied as NC if not used
phungductung 0:8ede47d38d10 58 *
phungductung 0:8ede47d38d10 59 * @param mosi SPI Master Out, Slave In pin
phungductung 0:8ede47d38d10 60 * @param miso SPI Master In, Slave Out pin
phungductung 0:8ede47d38d10 61 * @param sclk SPI Clock pin
phungductung 0:8ede47d38d10 62 * @param ssel SPI chip select pin
phungductung 0:8ede47d38d10 63 */
phungductung 0:8ede47d38d10 64 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel);
phungductung 0:8ede47d38d10 65
phungductung 0:8ede47d38d10 66 /** Configure the data transmission format
phungductung 0:8ede47d38d10 67 *
phungductung 0:8ede47d38d10 68 * @param bits Number of bits per SPI frame (4 - 16)
phungductung 0:8ede47d38d10 69 * @param mode Clock polarity and phase mode (0 - 3)
phungductung 0:8ede47d38d10 70 *
phungductung 0:8ede47d38d10 71 * @code
phungductung 0:8ede47d38d10 72 * mode | POL PHA
phungductung 0:8ede47d38d10 73 * -----+--------
phungductung 0:8ede47d38d10 74 * 0 | 0 0
phungductung 0:8ede47d38d10 75 * 1 | 0 1
phungductung 0:8ede47d38d10 76 * 2 | 1 0
phungductung 0:8ede47d38d10 77 * 3 | 1 1
phungductung 0:8ede47d38d10 78 * @endcode
phungductung 0:8ede47d38d10 79 */
phungductung 0:8ede47d38d10 80 void format(int bits, int mode = 0);
phungductung 0:8ede47d38d10 81
phungductung 0:8ede47d38d10 82 /** Set the spi bus clock frequency
phungductung 0:8ede47d38d10 83 *
phungductung 0:8ede47d38d10 84 * @param hz SCLK frequency in hz (default = 1MHz)
phungductung 0:8ede47d38d10 85 */
phungductung 0:8ede47d38d10 86 void frequency(int hz = 1000000);
phungductung 0:8ede47d38d10 87
phungductung 0:8ede47d38d10 88 /** Polls the SPI to see if data has been received
phungductung 0:8ede47d38d10 89 *
phungductung 0:8ede47d38d10 90 * @returns
phungductung 0:8ede47d38d10 91 * 0 if no data,
phungductung 0:8ede47d38d10 92 * 1 otherwise
phungductung 0:8ede47d38d10 93 */
phungductung 0:8ede47d38d10 94 int receive(void);
phungductung 0:8ede47d38d10 95
phungductung 0:8ede47d38d10 96 /** Retrieve data from receive buffer as slave
phungductung 0:8ede47d38d10 97 *
phungductung 0:8ede47d38d10 98 * @returns
phungductung 0:8ede47d38d10 99 * the data in the receive buffer
phungductung 0:8ede47d38d10 100 */
phungductung 0:8ede47d38d10 101 int read(void);
phungductung 0:8ede47d38d10 102
phungductung 0:8ede47d38d10 103 /** Fill the transmission buffer with the value to be written out
phungductung 0:8ede47d38d10 104 * as slave on the next received message from the master.
phungductung 0:8ede47d38d10 105 *
phungductung 0:8ede47d38d10 106 * @param value the data to be transmitted next
phungductung 0:8ede47d38d10 107 */
phungductung 0:8ede47d38d10 108 void reply(int value);
phungductung 0:8ede47d38d10 109
phungductung 0:8ede47d38d10 110 protected:
phungductung 0:8ede47d38d10 111 spi_t _spi;
phungductung 0:8ede47d38d10 112
phungductung 0:8ede47d38d10 113 int _bits;
phungductung 0:8ede47d38d10 114 int _mode;
phungductung 0:8ede47d38d10 115 int _hz;
phungductung 0:8ede47d38d10 116 };
phungductung 0:8ede47d38d10 117
phungductung 0:8ede47d38d10 118 } // namespace mbed
phungductung 0:8ede47d38d10 119
phungductung 0:8ede47d38d10 120 #endif
phungductung 0:8ede47d38d10 121
phungductung 0:8ede47d38d10 122 #endif