drv_spi.h

00001 /*******************************************************************************
00002  Simple SPI Transfer function
00003 
00004   File Name:
00005     drv_spi.h
00006 
00007   Summary:
00008     .
00009 
00010   Description:
00011     .
00012 
00013   Remarks:
00014     
00015  *******************************************************************************/
00016 
00017 // DOM-IGNORE-BEGIN
00018 /*******************************************************************************
00019 Copyright (c) 2016 Microchip Technology Inc. and its subsidiaries.  
00020 You may use this software and any derivatives exclusively with Microchip products. 
00021   
00022 THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS".  
00023 NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, 
00024 INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, 
00025 AND FITNESS FOR A PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, 
00026 COMBINATION WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION. 
00027 
00028 IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, 
00029 INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER 
00030 RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED 
00031 OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE.  TO THE FULLEST EXTENT ALLOWED BY LAW, 
00032 MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE 
00033 WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
00034 
00035 MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE TERMS.
00036  *******************************************************************************/
00037 // DOM-IGNORE-END
00038 
00039 #ifndef _DRV_SPI_H
00040 #define _DRV_SPI_H
00041 
00042 #include <string.h>
00043 
00044 //========================================================//
00045 #ifdef  __cplusplus
00046 extern "C" {
00047 #endif
00048 
00049 // Index to SPI channel
00050 // Used when multiple MCP2517FD are connected to the same SPI interface, but with different CS    
00051 #define DRV_CANFDSPI_INDEX_0         0
00052 #define DRV_CANFDSPI_INDEX_1         1
00053 
00054 //! SPI Initialization
00055     
00056 void DRV_SPI_Initialize(void);
00057 
00058 //! SPI Read/Write Transfer
00059 
00060 int8_t DRV_SPI_TransferData(uint8_t spiSlaveDeviceIndex, uint8_t *SpiTxData, uint8_t *SpiRxData, uint16_t XferSize);
00061 
00062 //! SPI Chip Select assert/de-assert
00063 
00064 int8_t DRV_SPI_ChipSelectAssert(uint8_t spiSlaveDeviceIndex, bool assert);
00065 
00066 //========================================================//
00067 #ifdef  __cplusplus
00068 }
00069 #endif
00070 //========================================================//
00071 #endif  /* _DRV_SPI_H */
00072