spi_api.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2013 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_SPI_API_H
00023 #define MBED_SPI_API_H
00024 
00025 #include "device.h"
00026 
00027 #if DEVICE_SPI
00028 
00029 #ifdef __cplusplus
00030 extern "C" {
00031 #endif
00032 
00033 typedef struct spi_s spi_t;
00034 
00035 void spi_init         (spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel);
00036 void spi_free         (spi_t *obj);
00037 void spi_format       (spi_t *obj, int bits, int mode, int slave);
00038 void spi_frequency    (spi_t *obj, int hz);
00039 int  spi_master_write (spi_t *obj, int value);
00040 int  spi_slave_receive(spi_t *obj);
00041 int  spi_slave_read   (spi_t *obj);
00042 void spi_slave_write  (spi_t *obj, int value);
00043 int  spi_busy         (spi_t *obj);
00044 
00045 #ifdef __cplusplus
00046 }
00047 #endif
00048 
00049 #endif
00050 
00051 #endif
00052