register_io_spi.h

Go to the documentation of this file.

/*
 * The Clear BSD License
 * Copyright (c) 2015 - 2016, Freescale Semiconductor, Inc.
 * Copyright 2016-2017 NXP
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted (subject to the limitations in the disclaimer below) provided
 * that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o Redistributions in binary form must reproduce the above copyright notice, this
 *   list of conditions and the following disclaimer in the documentation and/or
 *   other materials provided with the distribution.
 *
 * o Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @file register_io_spi.h
 * @brief The register_io_spi.h file declares low-level interface functions for reading
 * and writing sensor registers using CMSIS APIs.
 */

#ifndef __REGISTER_IO_SPI_H__
#define __REGISTER_IO_SPI_H__

#include "Driver_SPI.h"
#include "sensor_drv.h"

#define SPI_SS_ACTIVE_LOW (ARM_SPI_SS_INACTIVE)
#define SPI_SS_ACTIVE_HIGH (ARM_SPI_SS_ACTIVE)

/*! Function pointer for the slave read information*/
typedef void (*fpSpiReadPreprocessFn_t)(void *pCmdOut, uint32_t offset, uint32_t size);
/*! Function pointer for the slave write information*/
typedef void (*fpSpiWritePreprocessFn_t)(void *pCmdOut, uint32_t offset, uint32_t size, void *pWritebuffer);

/*! @brief The SPI Slave Control Command Params SDK2.0 Driver. */
typedef struct
{
    void *pTargetSlavePinID;
    uint8_t activeValue;
    uint8_t cmdCode;
} spiControlParams_t;

/*! @brief The SPI Slave Transfer Command Params SDK2.0 Driver. */
typedef struct spi_mater_SlaveCmd
{
    uint32_t size;         /*!< The tranfer size.*/
    uint8_t *pReadBuffer;  /*!< The handle the readbuffer.*/
    uint8_t *pWriteBuffer; /*!< The handle the writecommand.*/
} spiCmdParams_t;

/*! @brief This structure defines the spi slave command format. */
typedef struct
{
    fpSpiReadPreprocessFn_t pReadPreprocessFN;
    fpSpiWritePreprocessFn_t pWritePreprocessFN;
    void *pTargetSlavePinID;
    uint8_t spiCmdLen;
    uint8_t ssActiveValue;
} spiSlaveSpecificParams_t;

#if defined(SPI0)
/*! @brief The SPI0 device index. */
#define SPI0_INDEX 0

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI0_SignalEvent_t(uint32_t event);
#endif

#if defined(SPI1)
/*! @brief The SPI1 device index. */
#define SPI1_INDEX 1

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI1_SignalEvent_t(uint32_t event);
#endif

#if defined(SPI2)
/*! @brief The SPI2 device index. */
#define SPI2_INDEX 2

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI2_SignalEvent_t(uint32_t event);
#endif

#if defined(SPI3)
/*! @brief The SPI3 device index. */
#define SPI3_INDEX 3

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI3_SignalEvent_t(uint32_t event);
#endif

#if defined(SPI4)
/*! @brief The SPI4 device index. */
#define SPI4_INDEX 4

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI4_SignalEvent_t(uint32_t event);
#endif

#if defined(SPI5)
/*! @brief The SPI5 device index. */
#define SPI5_INDEX 5

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI5_SignalEvent_t(uint32_t event);
#endif

#if defined(SPI6)
/*! @brief The SPI6 device index. */
#define SPI6_INDEX 6

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI6_SignalEvent_t(uint32_t event);
#endif

#if defined(SPI7)
/*! @brief The SPI7 device index. */
#define SPI7_INDEX 7

/*! @brief       Defines the SPI signal event handler.
 *  @details     The Signal Event Handler function required by register_io_i2c.c.
 *  @param[in]   event The SPI event that occured.
 *  @Constraints None
 *  @Reentrant   Yes
 *  @return      void
 */
void SPI7_SignalEvent_t(uint32_t event);
#endif

/*!
 * @brief The interface function to block write to a sensor register.
 *
 * @param ARM_DRIVER_SPI *pCommDrv - The SPI driver to use.
 * @param registerDeviceInfo_t *devInfo - The SPI device number and idle function.
 * @param void *pWriteParams - the sensor's SPI slave select params.
 * @param uint8_t offset - The register/offset to write to
 * @param uint8_t *pBuffer - The buffer containing bytes to write.
 * @param uint8_t bytesToWrite - A number of bytes to write.
 *
 * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.
 */
int32_t Register_SPI_BlockWrite(ARM_DRIVER_SPI *pCommDrv,
                                registerDeviceInfo_t *devInfo,
                                void *pWriteParams,
                                uint8_t offset,
                                const uint8_t *pBuffer,
                                uint8_t bytesToWrite);

/*!
 * @brief The interface function to write a sensor register.
 *
 * @param ARM_DRIVER_SPI *pCommDrv - The SPI driver to use.
 * @param registerDeviceInfo_t *devInfo - The SPI device number and idle function.
 * @param void *pWriteParams - the sensor's SPI slave select params.
 * @param uint8_t offset - The register/offset to write to
 * @param uint8_t value - The value to write to the register
 * @param uint8_t mask - A mask value to use when writing.
 *                       A non-zero mask indicates that a read-modify-write operation should be used.
 *                       where only the bits set in the mask will be updated according to the value param.
 * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.
 */
int32_t Register_SPI_Write(ARM_DRIVER_SPI *pCommDrv,
                           registerDeviceInfo_t *devInfo,
                           void *pWriteParams,
                           uint8_t offset,
                           uint8_t value,
                           uint8_t mask);

/*!
 * @brief The interface function to read a sensor register.
 *
 * @param ARM_DRIVER_SPI *pCommDrv - The SPI driver to use.
 * @param registerDeviceInfo_t *devInfo - The SPI device number and idle function.
 * @param void *pReadParams - the sensor's SPI slave select params.
 * @param uint8_t offset - The register/offset to read from
 * @param uint8_t length - The number of bytes to read
 * @param uint8_t *pOutBuffer - The pointer to the buffer to store the register value read.
 *
 * @return ARM_DRIVER_OK if success or ARM_DRIVER_ERROR if error.
 */
int32_t Register_SPI_Read(ARM_DRIVER_SPI *pCommDrv,
                          registerDeviceInfo_t *devInfo,
                          void *pReadParams,
                          uint8_t offset,
                          uint8_t length,
                          uint8_t *pOutBuffer);

#endif // __REGISTER_IO_SPI_H__