Mike Pulice / ublox_C200Test

Integrating the ublox LISA C200 modem

Fork of SprintUSBModemHTTPClientTest by Donatien Garnier

mbed-src/api/SPISlave.h@5:3f93dd1d4cb3, 2013-09-26 (annotated)

Committer:
sam_grove
Date:
Thu Sep 26 00:44:20 2013 -0500
Revision:
5:3f93dd1d4cb3
Exported program and replaced contents of the repo with the source

to build and debug using keil mdk. Libs NOT upto date are lwip, lwip-sys

and socket. these have newer versions under mbed_official but were starting

from a know working point

Who changed what in which revision?

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