Pokitto Community Team / Pokitto_

PokittoLib with changes to lcd refresh etc.

Dependents:   Pokittris

Fork of Pokitto by Pokitto Community Team

This is a fork by user @Spinal, and is used in Pokittris for testing. Do not import this to your own program.

mbed-pokitto/api/SPISlave.h@11:02ad9c807a21, 2017-10-15 (annotated)

Committer:
spinal
Date:
Sun Oct 15 18:03:02 2017 +0000
Revision:
11:02ad9c807a21
Parent:
5:7e5c566b1760 
fixed 4color refreshRegion code

Who changed what in which revision?

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