Gonzalo Matarrubia / Mbed LPC1549 mod

This repo contains the libraries of Mbed for LPC1549 with following changes: - IAP commands. - EEPROM write and read. - UART write and read (public) - CAN can_s -> LPC_C_CAN0_Type *can

mbed/SPI.h@0:820a69dfd200, 2015-04-14 (annotated)

Committer:
gmatarrubia
Date:
Tue Apr 14 15:00:13 2015 +0200
Revision:
0:820a69dfd200
Initial repo. IAP commands, EEPROM write/read, UART write/read, CAN

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gmatarrubia 0:820a69dfd200 1 /* mbed Microcontroller Library
gmatarrubia 0:820a69dfd200 2 * Copyright (c) 2006-2013 ARM Limited
gmatarrubia 0:820a69dfd200 3 *
gmatarrubia 0:820a69dfd200 4 * Licensed under the Apache License, Version 2.0 (the "License");
gmatarrubia 0:820a69dfd200 5 * you may not use this file except in compliance with the License.
gmatarrubia 0:820a69dfd200 6 * You may obtain a copy of the License at
gmatarrubia 0:820a69dfd200 7 *
gmatarrubia 0:820a69dfd200 8 * http://www.apache.org/licenses/LICENSE-2.0
gmatarrubia 0:820a69dfd200 9 *
gmatarrubia 0:820a69dfd200 10 * Unless required by applicable law or agreed to in writing, software
gmatarrubia 0:820a69dfd200 11 * distributed under the License is distributed on an "AS IS" BASIS,
gmatarrubia 0:820a69dfd200 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gmatarrubia 0:820a69dfd200 13 * See the License for the specific language governing permissions and
gmatarrubia 0:820a69dfd200 14 * limitations under the License.
gmatarrubia 0:820a69dfd200 15 */
gmatarrubia 0:820a69dfd200 16 #ifndef MBED_SPI_H
gmatarrubia 0:820a69dfd200 17 #define MBED_SPI_H
gmatarrubia 0:820a69dfd200 18
gmatarrubia 0:820a69dfd200 19 #include "platform.h"
gmatarrubia 0:820a69dfd200 20
gmatarrubia 0:820a69dfd200 21 #if DEVICE_SPI
gmatarrubia 0:820a69dfd200 22
gmatarrubia 0:820a69dfd200 23 #include "spi_api.h"
gmatarrubia 0:820a69dfd200 24
gmatarrubia 0:820a69dfd200 25 namespace mbed {
gmatarrubia 0:820a69dfd200 26
gmatarrubia 0:820a69dfd200 27 /** A SPI Master, used for communicating with SPI slave devices
gmatarrubia 0:820a69dfd200 28 *
gmatarrubia 0:820a69dfd200 29 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
gmatarrubia 0:820a69dfd200 30 *
gmatarrubia 0:820a69dfd200 31 * Most SPI devices will also require Chip Select and Reset signals. These
gmatarrubia 0:820a69dfd200 32 * can be controlled using <DigitalOut> pins
gmatarrubia 0:820a69dfd200 33 *
gmatarrubia 0:820a69dfd200 34 * Example:
gmatarrubia 0:820a69dfd200 35 * @code
gmatarrubia 0:820a69dfd200 36 * // Send a byte to a SPI slave, and record the response
gmatarrubia 0:820a69dfd200 37 *
gmatarrubia 0:820a69dfd200 38 * #include "mbed.h"
gmatarrubia 0:820a69dfd200 39 *
gmatarrubia 0:820a69dfd200 40 * SPI device(p5, p6, p7); // mosi, miso, sclk
gmatarrubia 0:820a69dfd200 41 *
gmatarrubia 0:820a69dfd200 42 * int main() {
gmatarrubia 0:820a69dfd200 43 * int response = device.write(0xFF);
gmatarrubia 0:820a69dfd200 44 * }
gmatarrubia 0:820a69dfd200 45 * @endcode
gmatarrubia 0:820a69dfd200 46 */
gmatarrubia 0:820a69dfd200 47 class SPI {
gmatarrubia 0:820a69dfd200 48
gmatarrubia 0:820a69dfd200 49 public:
gmatarrubia 0:820a69dfd200 50
gmatarrubia 0:820a69dfd200 51 /** Create a SPI master connected to the specified pins
gmatarrubia 0:820a69dfd200 52 *
gmatarrubia 0:820a69dfd200 53 * Pin Options:
gmatarrubia 0:820a69dfd200 54 * (5, 6, 7) or (11, 12, 13)
gmatarrubia 0:820a69dfd200 55 *
gmatarrubia 0:820a69dfd200 56 * mosi or miso can be specfied as NC if not used
gmatarrubia 0:820a69dfd200 57 *
gmatarrubia 0:820a69dfd200 58 * @param mosi SPI Master Out, Slave In pin
gmatarrubia 0:820a69dfd200 59 * @param miso SPI Master In, Slave Out pin
gmatarrubia 0:820a69dfd200 60 * @param sclk SPI Clock pin
gmatarrubia 0:820a69dfd200 61 */
gmatarrubia 0:820a69dfd200 62 SPI(PinName mosi, PinName miso, PinName sclk, PinName _unused=NC);
gmatarrubia 0:820a69dfd200 63
gmatarrubia 0:820a69dfd200 64 /** Configure the data transmission format
gmatarrubia 0:820a69dfd200 65 *
gmatarrubia 0:820a69dfd200 66 * @param bits Number of bits per SPI frame (4 - 16)
gmatarrubia 0:820a69dfd200 67 * @param mode Clock polarity and phase mode (0 - 3)
gmatarrubia 0:820a69dfd200 68 *
gmatarrubia 0:820a69dfd200 69 * @code
gmatarrubia 0:820a69dfd200 70 * mode | POL PHA
gmatarrubia 0:820a69dfd200 71 * -----+--------
gmatarrubia 0:820a69dfd200 72 * 0 | 0 0
gmatarrubia 0:820a69dfd200 73 * 1 | 0 1
gmatarrubia 0:820a69dfd200 74 * 2 | 1 0
gmatarrubia 0:820a69dfd200 75 * 3 | 1 1
gmatarrubia 0:820a69dfd200 76 * @endcode
gmatarrubia 0:820a69dfd200 77 */
gmatarrubia 0:820a69dfd200 78 void format(int bits, int mode = 0);
gmatarrubia 0:820a69dfd200 79
gmatarrubia 0:820a69dfd200 80 /** Set the spi bus clock frequency
gmatarrubia 0:820a69dfd200 81 *
gmatarrubia 0:820a69dfd200 82 * @param hz SCLK frequency in hz (default = 1MHz)
gmatarrubia 0:820a69dfd200 83 */
gmatarrubia 0:820a69dfd200 84 void frequency(int hz = 1000000);
gmatarrubia 0:820a69dfd200 85
gmatarrubia 0:820a69dfd200 86 /** Write to the SPI Slave and return the response
gmatarrubia 0:820a69dfd200 87 *
gmatarrubia 0:820a69dfd200 88 * @param value Data to be sent to the SPI slave
gmatarrubia 0:820a69dfd200 89 *
gmatarrubia 0:820a69dfd200 90 * @returns
gmatarrubia 0:820a69dfd200 91 * Response from the SPI slave
gmatarrubia 0:820a69dfd200 92 */
gmatarrubia 0:820a69dfd200 93 virtual int write(int value);
gmatarrubia 0:820a69dfd200 94
gmatarrubia 0:820a69dfd200 95 public:
gmatarrubia 0:820a69dfd200 96 virtual ~SPI() {
gmatarrubia 0:820a69dfd200 97 }
gmatarrubia 0:820a69dfd200 98
gmatarrubia 0:820a69dfd200 99 protected:
gmatarrubia 0:820a69dfd200 100 spi_t _spi;
gmatarrubia 0:820a69dfd200 101
gmatarrubia 0:820a69dfd200 102 void aquire(void);
gmatarrubia 0:820a69dfd200 103 static SPI *_owner;
gmatarrubia 0:820a69dfd200 104 int _bits;
gmatarrubia 0:820a69dfd200 105 int _mode;
gmatarrubia 0:820a69dfd200 106 int _hz;
gmatarrubia 0:820a69dfd200 107 };
gmatarrubia 0:820a69dfd200 108
gmatarrubia 0:820a69dfd200 109 } // namespace mbed
gmatarrubia 0:820a69dfd200 110
gmatarrubia 0:820a69dfd200 111 #endif
gmatarrubia 0:820a69dfd200 112
gmatarrubia 0:820a69dfd200 113 #endif