PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/drivers/SPISlave.h@1:b36bbc1c6d27, 2020-04-11 (annotated)

Committer:
demayer
Date:
Sat Apr 11 08:15:48 2020 +0000
Revision:
1:b36bbc1c6d27
Parent:
0:6bf0743ece18 
IMU-library in .h und .cpp file aufgeteilt

Who changed what in which revision?

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