spi.h

00001 /***************************************************************************//**
00002  *   @file   spi.h
00003  *   @author DBogdan (dragos.bogdan@analog.com)
00004 ********************************************************************************
00005  * Copyright 2019(c) Analog Devices, Inc.
00006  *
00007  * All rights reserved.
00008  *
00009  * Redistribution and use in source and binary forms, with or without
00010  * modification, are permitted provided that the following conditions are met:
00011  *  - Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *  - Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in
00015  *    the documentation and/or other materials provided with the
00016  *    distribution.
00017  *  - Neither the name of Analog Devices, Inc. nor the names of its
00018  *    contributors may be used to endorse or promote products derived
00019  *    from this software without specific prior written permission.
00020  *  - The use of this software may or may not infringe the patent rights
00021  *    of one or more patent holders.  This license does not release you
00022  *    from the requirement that you obtain separate licenses from these
00023  *    patent holders to use this software.
00024  *  - Use of the software either in source or binary form, must be run
00025  *    on or directly connected to an Analog Devices Inc. component.
00026  *
00027  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
00028  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
00029  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00030  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
00031  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
00033  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00034  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00035  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 *******************************************************************************/
00038 
00039 #ifndef SPI_H_
00040 #define SPI_H_
00041 
00042 /******************************************************************************/
00043 /***************************** Include Files **********************************/
00044 /******************************************************************************/
00045 
00046 #include <stdint.h>
00047 
00048 /******************************************************************************/
00049 /********************** Macros and Constants Definitions **********************/
00050 /******************************************************************************/
00051 
00052 #define SPI_CPHA    0x01
00053 #define SPI_CPOL    0x02
00054 
00055 /******************************************************************************/
00056 /*************************** Types Declarations *******************************/
00057 /******************************************************************************/
00058 
00059 typedef enum spi_mode {
00060     SPI_MODE_0 = (0 | 0),
00061     SPI_MODE_1 = (0 | SPI_CPHA),
00062     SPI_MODE_2 = (SPI_CPOL | 0),
00063     SPI_MODE_3 = (SPI_CPOL | SPI_CPHA)
00064 } spi_mode;
00065 
00066 typedef struct spi_init_param {
00067     uint32_t    max_speed_hz;
00068     uint8_t     chip_select;
00069     enum spi_mode   mode;
00070     void        *extra;
00071 } spi_init_param;
00072 
00073 typedef struct spi_desc {
00074     uint32_t    max_speed_hz;
00075     uint8_t     chip_select;
00076     enum spi_mode   mode;
00077     void        *extra;
00078 } spi_desc;
00079 
00080 /******************************************************************************/
00081 /************************ Functions Declarations ******************************/
00082 /******************************************************************************/
00083 
00084 /* Initialize the SPI communication peripheral. */
00085 int32_t spi_init(struct spi_desc **desc,
00086          const struct spi_init_param *param);
00087 
00088 /* Free the resources allocated by spi_init(). */
00089 int32_t spi_remove(struct spi_desc *desc);
00090 
00091 /* Write and read data to/from SPI. */
00092 int32_t spi_write_and_read(struct spi_desc *desc,
00093                uint8_t *data,
00094                uint16_t bytes_number);
00095 
00096 #endif // SPI_H_