Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

targets/TARGET_ONSEMI/TARGET_NCS36510/spi.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /**
elessair 0:f269e3021894 2 ******************************************************************************
elessair 0:f269e3021894 3 * @file spi.h
elessair 0:f269e3021894 4 * @brief Inlcude file of a SPI master driver
elessair 0:f269e3021894 5 * @internal
elessair 0:f269e3021894 6 * @author ON Semiconductor
elessair 0:f269e3021894 7 * @version $Rev: $
elessair 0:f269e3021894 8 * @date $Date: 2016-02-05 $
elessair 0:f269e3021894 9 ******************************************************************************
elessair 0:f269e3021894 10 * Copyright 2016 Semiconductor Components Industries LLC (d/b/a “ON Semiconductor”).
elessair 0:f269e3021894 11 * All rights reserved. This software and/or documentation is licensed by ON Semiconductor
elessair 0:f269e3021894 12 * under limited terms and conditions. The terms and conditions pertaining to the software
elessair 0:f269e3021894 13 * and/or documentation are available at http://www.onsemi.com/site/pdf/ONSEMI_T&C.pdf
elessair 0:f269e3021894 14 * (“ON Semiconductor Standard Terms and Conditions of Sale, Section 8 Software”) and
elessair 0:f269e3021894 15 * if applicable the software license agreement. Do not use this software and/or
elessair 0:f269e3021894 16 * documentation unless you have carefully read and you agree to the limited terms and
elessair 0:f269e3021894 17 * conditions. By using this software and/or documentation, you agree to the limited
elessair 0:f269e3021894 18 * terms and conditions.
elessair 0:f269e3021894 19 *
elessair 0:f269e3021894 20 * THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
elessair 0:f269e3021894 21 * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
elessair 0:f269e3021894 22 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
elessair 0:f269e3021894 23 * ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL,
elessair 0:f269e3021894 24 * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
elessair 0:f269e3021894 25 * @endinternal
elessair 0:f269e3021894 26 *
elessair 0:f269e3021894 27 * @ingroup spi_h
elessair 0:f269e3021894 28 *
elessair 0:f269e3021894 29 * @details
elessair 0:f269e3021894 30 *
elessair 0:f269e3021894 31 */
elessair 0:f269e3021894 32 #ifndef SPI_H_
elessair 0:f269e3021894 33 #define SPI_H_
elessair 0:f269e3021894 34
elessair 0:f269e3021894 35 #include "device.h"
elessair 0:f269e3021894 36 #include "spi_api.h"
elessair 0:f269e3021894 37
elessair 0:f269e3021894 38 #if DEVICE_SPI
elessair 0:f269e3021894 39
elessair 0:f269e3021894 40 #ifdef __cplusplus
elessair 0:f269e3021894 41 extern "C" {
elessair 0:f269e3021894 42 #endif
elessair 0:f269e3021894 43
elessair 0:f269e3021894 44 /* Miscellaneous I/O and control operations codes */
elessair 0:f269e3021894 45 #define SPI_IPC7207_IOCTL_GET_SLAVE_SELECT (0x1) /**< <b>Ioctl request code</b>: Reading slaveSelect register */
elessair 0:f269e3021894 46 #define SPI_IPC7207_IOCTL_SET_SLAVE_SELECT (0x2) /**< <b>Ioctl request code</b>: Setting slaveSelect register */
elessair 0:f269e3021894 47 #define SPI_IPC7207_IOCTL_FLUSH (0x3) /**< <b>Ioctl request code</b>: Flushin FIFOs and serial shift registers */
elessair 0:f269e3021894 48
elessair 0:f269e3021894 49 /* Control register bit positions */
elessair 0:f269e3021894 50 #define SPI_WORD_WIDTH_BIT_POS 6
elessair 0:f269e3021894 51 #define SPI_SLAVE_MASTER_BIT_POS 5
elessair 0:f269e3021894 52 #define SPI_CPOL_BIT_POS 4
elessair 0:f269e3021894 53 #define SPI_CPHA_BIT_POS 3
elessair 0:f269e3021894 54 #define SPI_ENDIAN_BIT_POS 2
elessair 0:f269e3021894 55 #define SPI_SAMPLE_EDGE_BIT_POS 1
elessair 0:f269e3021894 56 #define SPI_PORT_ENABLE_BIT_POS 0
elessair 0:f269e3021894 57
elessair 0:f269e3021894 58 /* COntrol register bits */
elessair 0:f269e3021894 59 #define SPI_ENDIAN_MSB_FIRST 1
elessair 0:f269e3021894 60 #define SPI_CPOL_IDLE_LOW 0
elessair 0:f269e3021894 61 #define SPI_CPHA_BEFORE_1ST_EDGE 0
elessair 0:f269e3021894 62 #define SPI_MASTER_MODE 1
elessair 0:f269e3021894 63 #define SPI_WORD_WIDTH_8_BITS 0
elessair 0:f269e3021894 64 #define SPI_SAMPLE_OPP_CLK_EDGE_DATA 0
elessair 0:f269e3021894 65 #define SPI_SLAVE_SELECT_NORM_BEHAVE 0
elessair 0:f269e3021894 66 #define SPI_PORT_ENABLE 1
elessair 0:f269e3021894 67
elessair 0:f269e3021894 68 #define SPI_SLAVE_SELECT_DEFAULT 0x10
elessair 0:f269e3021894 69
elessair 0:f269e3021894 70 #define SPI_DEFAULT_CONFIG 0x25
elessair 0:f269e3021894 71
elessair 0:f269e3021894 72 #define SPI_DEFAULT_SPEED 1000000
elessair 0:f269e3021894 73 #define SPI_BYTE_MASK 0xFF
elessair 0:f269e3021894 74
elessair 0:f269e3021894 75 extern void fSpiInit(spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel);
elessair 0:f269e3021894 76 extern void fSpiClose(spi_t *obj);
elessair 0:f269e3021894 77 extern int fSpiWriteB(spi_t *obj, uint32_t const buf);
elessair 0:f269e3021894 78
elessair 0:f269e3021894 79 #ifdef __cplusplus
elessair 0:f269e3021894 80 }
elessair 0:f269e3021894 81 #endif /* __cplusplus */
elessair 0:f269e3021894 82
elessair 0:f269e3021894 83 #endif /* DEVICE_SPI */
elessair 0:f269e3021894 84
elessair 0:f269e3021894 85 #endif /* SPI_H_ */