伊生希 小林 / Mbed 2 deprecated cansat_main_copy

temp

Dependencies:   mbed SDFileSystem MS5607 ADXL345_I2C FATFileSystem

mbed/drivers/SPISlave.h@0:c88c3b616c00, 2020-03-16 (annotated)

Committer:
IKobayashi
Date:
Mon Mar 16 23:37:42 2020 +0900
Revision:
0:c88c3b616c00
copy

Who changed what in which revision?

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