mbed

Fork of mbed-dev by mbed official

targets/TARGET_ONSEMI/TARGET_NCS36510/spi.h

Committer:
<>
Date:
2016-10-28
Revision:
149:156823d33999

File content as of revision 149:156823d33999:

/**
 ******************************************************************************
 * @file spi.h
 * @brief Inlcude file of a SPI master driver
 * @internal
 * @author ON Semiconductor
 * @version $Rev:  $
 * @date $Date: 2016-02-05 $
 ******************************************************************************
 * Copyright 2016 Semiconductor Components Industries LLC (d/b/a “ON Semiconductor”).
 * All rights reserved.  This software and/or documentation is licensed by ON Semiconductor
 * under limited terms and conditions.  The terms and conditions pertaining to the software
 * and/or documentation are available at http://www.onsemi.com/site/pdf/ONSEMI_T&C.pdf
 * (“ON Semiconductor Standard Terms and Conditions of Sale, Section 8 Software”) and
 * if applicable the software license agreement.  Do not use this software and/or
 * documentation unless you have carefully read and you agree to the limited terms and
 * conditions.  By using this software and/or documentation, you agree to the limited
 * terms and conditions.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 * ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL,
 * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 * @endinternal
 *
 * @ingroup spi_h
 *
 * @details
 *
 */
#ifndef SPI_H_
#define SPI_H_

#include "device.h"
#include "spi_api.h"

#if DEVICE_SPI

#ifdef __cplusplus
extern "C" {
#endif

/* Miscellaneous I/O and control operations codes */
#define SPI_IPC7207_IOCTL_GET_SLAVE_SELECT    (0x1) /**< <b>Ioctl request code</b>: Reading slaveSelect register */
#define SPI_IPC7207_IOCTL_SET_SLAVE_SELECT    (0x2) /**< <b>Ioctl request code</b>: Setting slaveSelect register */
#define SPI_IPC7207_IOCTL_FLUSH               (0x3) /**< <b>Ioctl request code</b>: Flushin FIFOs and serial shift registers */

/* Control register bit positions */
#define SPI_WORD_WIDTH_BIT_POS          6
#define SPI_SLAVE_MASTER_BIT_POS        5
#define SPI_CPOL_BIT_POS                4
#define SPI_CPHA_BIT_POS                3
#define SPI_ENDIAN_BIT_POS              2
#define SPI_SAMPLE_EDGE_BIT_POS         1
#define SPI_PORT_ENABLE_BIT_POS         0

/* COntrol register bits */
#define SPI_ENDIAN_MSB_FIRST            1
#define SPI_CPOL_IDLE_LOW               0
#define SPI_CPHA_BEFORE_1ST_EDGE        0
#define SPI_MASTER_MODE                 1
#define SPI_WORD_WIDTH_8_BITS           0
#define SPI_SAMPLE_OPP_CLK_EDGE_DATA    0
#define SPI_SLAVE_SELECT_NORM_BEHAVE    0
#define SPI_PORT_ENABLE                 1

#define SPI_SLAVE_SELECT_DEFAULT        0x10

#define SPI_DEFAULT_CONFIG              0x25

#define SPI_DEFAULT_SPEED               1000000
#define SPI_BYTE_MASK                   0xFF

extern void fSpiInit(spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel);
extern void fSpiClose(spi_t *obj);
extern int fSpiWriteB(spi_t *obj, uint32_t const buf);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* DEVICE_SPI */

#endif /* SPI_H_ */