cc y / mbed

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.

Fork of mbed by mbed official

SPISlave.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
101:7cff1c4259d7 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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