/********************************************************************* * Flowcode CAL SPI File * * File: PIC16BIT_CAL_SPI.c * * (c) 2011 Matrix Multimedia Ltd. * http://www.matrixmultimedia.com * * Software License Agreement * * The software supplied herewith by Matrix Multimedia Ltd (the * “Company”) for its Flowcode graphical programming language is * intended and supplied to you, the Company’s customer, for use * solely and exclusively on the Company's products. The software * is owned by the Company, and is protected under applicable * copyright laws. All rights are reserved. Any use in violation * of the foregoing restrictions may subject the user to criminal * sanctions under applicable laws, as well as to civil liability * for the breach of the terms and conditions of this licence. * * THIS SOFTWARE IS PROVIDED IN AN “AS IS” CONDITION. 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. THE COMPANY SHALL NOT, * IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER. * * Changelog: * * date | by | description * -------+----+----------------------------------------------------- * 090911 | BR | Created * 050312 | BR | Updated to v5.1 CAL Schema * 200712 | BR | Added new macro to configure prescaler on the fly * 090812 | ST | Fixed initial clock polarity setting * 090812 | ST | Added comments to explain the BMODE settings and Master_Byte function * 170812 | BR | Removed unneeded #endif statements * 070912 | BR | Changed Remappable Functionality to be loaded from FCD * 110912 | BR | Added minor mod for SPI channel 2,3 and 4 for MX_SPICON devices * 140912 | BR | Chaned prescaler function to tie in with the FAT component * 181012 | LM | Dummy read to clear flags * 210613 | BR | Bug fix defines mod for HW SPI Prescaler - also related mods to init * 030713 | LM | Standard API calls * 280813 | LM | Removed MX_SPI_x define checks * 011214 | LM | dsPIC Manual: The SMP bit must be set only after setting the MSTEN bit. */ //When using hardware SPI channels override port and pin conns with FCD conn definitions //Only overwrite CS pin defines when using SPI in slave mode on a hardware channel //Also sort out postscale and prescale options for hardware channels #define MX_SPI_REF_X CAL_APPEND(MX_SPI_REF, MX_SPI_NUM) #define MX_SPI_CHANNEL_X CAL_APPEND(MX_SPI_CHANNEL_, MX_SPI_NUM) #define MX_SPI_MOSI_PIN_X CAL_APPEND(MX_SPI_MOSI_PIN_, MX_SPI_NUM) #define MX_SPI_MOSI_PORT_X CAL_APPEND(MX_SPI_MOSI_PORT_, MX_SPI_NUM) #define MX_SPI_MOSI_TRIS_X CAL_APPEND(MX_SPI_MOSI_TRIS_, MX_SPI_NUM) #define MX_SPI_MISO_PIN_X CAL_APPEND(MX_SPI_MISO_PIN_, MX_SPI_NUM) #define MX_SPI_MISO_PORT_X CAL_APPEND(MX_SPI_MISO_PORT_, MX_SPI_NUM) #define MX_SPI_MISO_TRIS_X CAL_APPEND(MX_SPI_MISO_TRIS_, MX_SPI_NUM) #define MX_SPI_SCK_PIN_X CAL_APPEND(MX_SPI_SCK_PIN_, MX_SPI_NUM) #define MX_SPI_SCK_PORT_X CAL_APPEND(MX_SPI_SCK_PORT_, MX_SPI_NUM) #define MX_SPI_SCK_TRIS_X CAL_APPEND(MX_SPI_SCK_TRIS_, MX_SPI_NUM) #define MX_SPI_CS_PIN_X CAL_APPEND(MX_SPI_CS_PIN_, MX_SPI_NUM) #define MX_SPI_CS_PORT_X CAL_APPEND(MX_SPI_CS_PORT_, MX_SPI_NUM) #define MX_SPI_CS_TRIS_X CAL_APPEND(MX_SPI_CS_TRIS_, MX_SPI_NUM) #define MX_SPI_BMODE_X CAL_APPEND(MX_SPI_BMODE_, MX_SPI_NUM) #define MX_SPI_PR_SCALE_X CAL_APPEND(MX_SPI_PR_SCALE_, MX_SPI_NUM) #define MX_SPI_PO_SCALE_X CAL_APPEND(MX_SPI_PO_SCALE_, MX_SPI_NUM) #define MX_SPI_INT_X CAL_APPEND(MX_SPI_INT_, MX_SPI_NUM) //Setup Definitions #ifdef MX_SPI_REF_X #if MX_SPI_CHANNEL_X > 0 #if MX_SPI_PR_SCALE_X == 2 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x1B #endif #if MX_SPI_PR_SCALE_X == 4 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x1E #endif #if MX_SPI_PR_SCALE_X == 8 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x1A #endif #if MX_SPI_PR_SCALE_X == 16 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x1D #endif #if MX_SPI_PR_SCALE_X == 32 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x19 #endif #if MX_SPI_PR_SCALE_X == 64 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x1C #endif #if MX_SPI_PR_SCALE_X == 128 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x18 #endif #if MX_SPI_PR_SCALE_X == 192 #undef MX_SPI_PR_SCALE_X #define MX_SPI_PR_SCALE_X 0x14 #endif #endif #endif #define MX_PRESCALE_VAR_X CAL_APPEND(prescale_, MX_SPI_NUM) MX_UINT8 MX_PRESCALE_VAR_X = (MX_SPI_PR_SCALE_X / 2) - 1; //Function Prototypes CALFUNCTION(void, FC_CAL_SPI_Master_Init_, (void)); CALFUNCTION(void, FC_CAL_SPI_Master_Uninit_, (void)); CALFUNCTION(MX_UINT8, FC_CAL_SPI_Master_Byte_, (MX_UINT8 DataOut)); CALFUNCTION(void, FC_CAL_SPI_SetPrescaler_, (MX_UINT8 Prescaler)); CALFUNCTION(void, FC_CAL_SPI_Slave_Init_, (void)); CALFUNCTION(void, FC_CAL_SPI_Slave_Uninit_, (void)); CALFUNCTION(void, FC_CAL_SPI_Slave_SetTxData_, (MX_UINT8 Data)); CALFUNCTION(MX_UINT8, FC_CAL_SPI_Slave_GetRxData_, (void)); #ifdef MX_SPI1CON #define SPI1CON1 SPI1CON #define SPI1CON1bits SPI1CONbits #define SPI2CON1 SPI2CON #define SPI2CON1bits SPI2CONbits #define SPI3CON1 SPI3CON #define SPI3CON1bits SPI3CONbits #define SPI4CON1 SPI4CON #define SPI4CON1bits SPI4CONbits #endif //Bus Mode - Bit0=CKP=CPOL, Bit1=CKE=!CPHA, Bit2=CSMP //CKP=CPOL - Clock Polarity - Idle State of the clock 0=0, 1=1 //CKE=CPHA - Clock Phase - Clock Edge 0=leading edge, 1=trailing edge //CSMP - Input Data Bit Sample Phase //CRAT - SPI Clock Rate 0=1/4, 1=1/16, 2=1/64 // There are 4 SPI clock modes as follows: // // SPI Mode | CKP (CPOL) | CKE (CPHA) | BMODE | Explanation //----------+------------+--------------------+------------------------------------------------ // 1 (0,1) | 0 (0) | 0 (1) | xx00 | idle low; data out on falling/trailing edge // 3 (1,1) | 1 (1) | 0 (1) | xx01 | idle high; data out on rising/trailing edge // 0 (0,0) | 0 (0) | 1 (0) | xx10 | idle low; data out on rising/leading edge // 2 (1,0) | 1 (1) | 1 (0) | xx11 | idle high; data out on falling/leading edge //----------+------------+--------------------------------------------------------------------- // // So: // BMODE & 0x01 = CKP = CPOL // BMODE & 0x02 = CKE = !CPHA CALFUNCTION(void, FC_CAL_SPI_Master_Init_, (void)) { FC_CAL_Bit_High_DDR (MX_SPI_MOSI_PORT_X, MX_SPI_MOSI_TRIS_X, MX_SPI_MOSI_PIN_X); // MOSI pin is default high FC_CAL_Bit_In_DDR (MX_SPI_MISO_PORT_X, MX_SPI_MISO_TRIS_X, MX_SPI_MISO_PIN_X); // MISO pin is a input #if (MX_SPI_BMODE_X & 0x01) FC_CAL_Bit_High_DDR (MX_SPI_SCK_PORT_X, MX_SPI_SCK_TRIS_X, MX_SPI_SCK_PIN_X); // Clock pin is default high #else FC_CAL_Bit_Low_DDR (MX_SPI_SCK_PORT_X, MX_SPI_SCK_TRIS_X, MX_SPI_SCK_PIN_X); // Clock pin is default low #endif #if (MX_SPI_CHANNEL_X == 1) #ifdef MX_SPI_1_REMAPPABLE MX_SPI_1_MISO_RPINR = MX_SPI_1_MISO_RP; MX_SPI_1_MOSI_RPOR = MX_SPI_1_MOSI_SDO; MX_SPI_1_CLK_RPOR = MX_SPI_1_CLK_SCK; #endif SPI1CON1 = MX_SPI_PR_SCALE_X & 0x1F; //Assign Clock Prescalers SPI1CON1bits.MSTEN = 1; //master mode SPI1CON1bits.CKP = MX_SPI_BMODE_X & 0x01; //Assign Clock Polarity SPI1CON1bits.CKE = (MX_SPI_BMODE_X & 0x02) >> 1; //Assign Clock Phase SPI1CON1bits.SMP = (MX_SPI_BMODE_X & 0x04) >> 2; //Assign Input Data Phase SPI1STATbits.SPIROV = 0; //clear unread data flag SPI1STATbits.SPIEN = 1; //enable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 2) #ifdef MX_SPI_2_REMAPPABLE MX_SPI_2_MISO_RPINR = MX_SPI_2_MISO_RP; MX_SPI_2_MOSI_RPOR = MX_SPI_2_MOSI_SDO; MX_SPI_2_CLK_RPOR = MX_SPI_2_CLK_SCK; #endif SPI2CON1 = MX_SPI_PR_SCALE_X & 0x1F; //Assign Clock Prescalers SPI2CON1bits.MSTEN = 1; //master mode SPI2CON1bits.CKP = MX_SPI_BMODE_X & 0x01; //Assign Clock Polarity SPI2CON1bits.CKE = (MX_SPI_BMODE_X & 0x02) >> 1; //Assign Clock Phase SPI2CON1bits.SMP = (MX_SPI_BMODE_X & 0x04) >> 2; //Assign Input Data Phase SPI2STATbits.SPIROV = 0; //clear unread data flag SPI2STATbits.SPIEN = 1; //enable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 3) #ifdef MX_SPI_3_REMAPPABLE MX_SPI_3_MISO_RPINR = MX_SPI_3_MISO_RP; MX_SPI_3_MOSI_RPOR = MX_SPI_3_MOSI_SDO; MX_SPI_3_CLK_RPOR = MX_SPI_3_CLK_SCK; #endif SPI3CON1 = MX_SPI_PR_SCALE_X & 0x1F; //Assign Clock Prescalers SPI3CON1bits.MSTEN = 1; //master mode SPI3CON1bits.CKP = MX_SPI_BMODE_X & 0x01; //Assign Clock Polarity SPI3CON1bits.CKE = (MX_SPI_BMODE_X & 0x02) >> 1; //Assign Clock Phase SPI3CON1bits.SMP = (MX_SPI_BMODE_X & 0x04) >> 2; //Assign Input Data Phase SPI3STATbits.SPIROV = 0; //clear unread data flag SPI3STATbits.SPIEN = 1; //enable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 4) #ifdef MX_SPI_4_REMAPPABLE MX_SPI_4_MISO_RPINR = MX_SPI_4_MISO_RP; MX_SPI_4_MOSI_RPOR = MX_SPI_4_MOSI_SDO; MX_SPI_4_CLK_RPOR = MX_SPI_4_CLK_SCK; #endif SPI4CON1 = MX_SPI_PR_SCALE_X & 0x1F; //Assign Clock Prescalers SPI4CON1bits.MSTEN = 1; //master mode SPI4CON1bits.CKP = MX_SPI_BMODE_X & 0x01; //Assign Clock Polarity SPI4CON1bits.CKE = (MX_SPI_BMODE_X & 0x02) >> 1; //Assign Clock Phase SPI4CON1bits.SMP = (MX_SPI_BMODE_X & 0x04) >> 2; //Assign Input Data Phase SPI4STATbits.SPIROV = 0; //clear unread data flag SPI4STATbits.SPIEN = 1; //enable SPI peripheral #endif } CALFUNCTION(void, FC_CAL_SPI_Master_Uninit_, (void)) { #if (MX_SPI_CHANNEL_X == 1) SPI1STATbits.SPIEN = 0; //disable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 2) SPI2STATbits.SPIEN = 0; //disable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 3) SPI3STATbits.SPIEN = 0; //disable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 4) SPI4STATbits.SPIEN = 0; //disable SPI peripheral #endif //Reset Pins to Inputs FC_CAL_Bit_In_DDR (MX_SPI_MOSI_PORT_X, MX_SPI_MOSI_TRIS_X, MX_SPI_MOSI_PIN_X); FC_CAL_Bit_In_DDR (MX_SPI_MISO_PORT_X, MX_SPI_MISO_TRIS_X, MX_SPI_MISO_PIN_X); FC_CAL_Bit_In_DDR (MX_SPI_SCK_PORT_X, MX_SPI_SCK_TRIS_X, MX_SPI_SCK_PIN_X); } CALFUNCTION(MX_UINT8, FC_CAL_SPI_Master_Byte_, (MX_UINT8 DataOut)) { MX_UINT8 retVal = 0; #if (MX_SPI_CHANNEL_X == 0) MX_UINT8 i, idx; for (idx = 0; idx < 8; idx++) { retVal = retVal << 1; //If mode 1 or 3, switch the clock #if ((MX_SPI_BMODE_X & 0x02) == 0x00) //CKE = 0; (mode 1 or 3) Set SCK active before data #if ((MX_SPI_BMODE_X & 0x01) == 0x00) FC_CAL_Bit_High(MX_SPI_SCK_PORT_X, MX_SPI_SCK_PIN_X); //CKP = 0; (mode 1) #else FC_CAL_Bit_Low(MX_SPI_SCK_PORT_X, MX_SPI_SCK_PIN_X); //CKP = 1; (mode 3) #endif #endif //Data setup if (DataOut & 0x80) //Test Data bit FC_CAL_Bit_High(MX_SPI_MOSI_PORT_X, MX_SPI_MOSI_PIN_X); //Set SDO bit else FC_CAL_Bit_Low (MX_SPI_MOSI_PORT_X, MX_SPI_MOSI_PIN_X); //Clear SDO bit //Clock delay for (i=0; i 0) if (Prescaler == 0) //1:2 MX_PRESCALE_VAR_X = 0x1B; if (Prescaler == 1) //1:4 MX_PRESCALE_VAR_X = 0x1E; if (Prescaler == 2) //1:8 MX_PRESCALE_VAR_X = 0x1A; if (Prescaler == 3) //1:16 MX_PRESCALE_VAR_X = 0x1D; if (Prescaler == 4) //1:32 MX_PRESCALE_VAR_X = 0x19; if (Prescaler == 5) //1:64 MX_PRESCALE_VAR_X = 0x1C; if (Prescaler == 6) //1:128 MX_PRESCALE_VAR_X = 0x18; if (Prescaler == 7) //1:192 MX_PRESCALE_VAR_X = 0x14; #endif #if (MX_SPI_CHANNEL_X == 1) SPI1STATbits.SPIEN = 0; //Disable SPI peripheral SPI1CON1 = SPI1CON1 & 0xFFE0; SPI1CON1 = SPI1CON1 | (MX_PRESCALE_VAR_X & 0x1F); //Assign Clock Prescalers SPI1STATbits.SPIEN = 1; //Enable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 2) SPI2STATbits.SPIEN = 0; //Disable SPI peripheral SPI2CON1 = SPI2CON1 & 0xFFE0; SPI2CON1 = SPI2CON1 | (MX_PRESCALE_VAR_X & 0x1F); //Assign Clock Prescalers SPI2STATbits.SPIEN = 1; //Enable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 3) SPI3STATbits.SPIEN = 0; //Disable SPI peripheral SPI3CON1 = SPI3CON1 & 0xFFE0; SPI3CON1 = SPI3CON1 | (MX_PRESCALE_VAR_X & 0x1F); //Assign Clock Prescalers SPI3STATbits.SPIEN = 1; //Enable SPI peripheral #endif #if (MX_SPI_CHANNEL_X == 4) SPI4STATbits.SPIEN = 0; //Disable SPI peripheral SPI4CON1 = SPI4CON1 & 0xFFE0; SPI4CON1 = SPI4CON1 | (MX_PRESCALE_VAR_X & 0x1F); //Assign Clock Prescalers SPI4STATbits.SPIEN = 1; //Enable SPI peripheral #endif } CALFUNCTION(void, FC_CAL_SPI_Slave_Init_, (void)) { } CALFUNCTION(void, FC_CAL_SPI_Slave_Uninit_, (void)) { } CALFUNCTION(void, FC_CAL_SPI_Slave_SetTxData_, (MX_UINT8 Data)) { } CALFUNCTION(MX_UINT8, FC_CAL_SPI_Slave_GetRxData_, (void)) { return(0); } #undef MX_SPI_PR_SCALE_X