1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/**
MSSP1_SPI Generated Driver API Header File
@Company
Microchip Technology Inc.
@File Name
mssp1_spi.h
@Summary
This is the generated header file for the MSSP1_SPI driver using PIC24 / dsPIC33 / PIC32MM MCUs
@Description
This header file provides APIs for driver for MSSP1_SPI.
Generation Information :
Product Revision : PIC24 / dsPIC33 / PIC32MM MCUs - 1.171.4
Device : PIC24FV16KM202
The generated drivers are tested against the following:
Compiler : XC16 v2.10
MPLAB : MPLAB X v6.05
*/
/*
(c) 2020 Microchip Technology Inc. and its subsidiaries. You may use this
software and any derivatives exclusively with Microchip products.
THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION
WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.
IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE
TERMS.
*/
#ifndef _MSSP1_SPI_H
#define _MSSP1_SPI_H
/**
Section: Included Files
*/
#include <xc.h>
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#ifdef __cplusplus // Provide C++ Compatibility
extern "C" {
#endif
/**
Section: Data Type Definitions
*/
//This definition is used during read operation of SPI
#define MSSP1_SPI_DUMMY_DATA 0x0
/**
Section: Interface Routines
*/
/**
@Summary
Initializes the MSSP instance : 1
@Description
This routine initializes the mssp1_spi driver instance for : 1
index, making it ready for clients to open and use it.
This routine must be called before any other MSSP1_SPI routine is called.
This routine should only be called once during system initialization.
@Preconditions
None.
@Param
None.
@Returns
None.
@Example
<code>
uint16_t myWriteBuffer[MY_BUFFER_SIZE];
uint16_t myReadBuffer[MY_BUFFER_SIZE];
uint16_t writeData;
uint16_t readData;
unsigned int total;
MSSP1_SPI_Initialize;
total = 0;
do
{
total = MSSP1_SPI_Exchange8bitBuffer( &myWriteBuffer[total], MY_BUFFER_SIZE - total, &myWriteBuffer[total]);
// Do something else...
} while( total < MY_BUFFER_SIZE );
readData = MSSP1_SPI_Exchange8bit( writeData);
</code>
*/
void MSSP1_SPI_Initialize (void);
/**
@Summary
Exchanges one byte of data from MSSP1_SPI
@Description
This routine exchanges one byte of data from the MSSP1_SPI.
This is a blocking routine.
@Preconditions
The MSSP1_SPI_Initialize routine must have been called for the specified
MSSP1_SPI driver instance.
@Param
data - Data to be written onto MSSP1_SPI.
@Returns
Data read from MSSP1_SPI
@Example
Refer to MSSP1_SPI_Initialize() for an example
*/
uint8_t MSSP1_SPI_Exchange8bit( uint8_t data );
/**
@Summary
Exchanges data from a buffer of size one byte from MSSP1_SPI
@Description
This routine exchanges data from a buffer of size one byte from the MSSP1_SPI.
This is a blocking routine.
@Preconditions
The MSSP1_SPI_Initialize routine must have been called for the specified
MSSP1_SPI driver instance.
@Param
dataTransmitted - Buffer of data to be written from MSSP1_SPI.
bufLen - Number of words to be exchanged.
dataReceived - Buffer of data to be read into MSSP1_SPI.
@Returns
Number of words written/read.
@Example
Refer to MSSP1_SPI_Initialize() for an example
*/
uint8_t MSSP1_SPI_Exchange8bitBuffer(uint8_t *dataTransmitted, uint8_t bufLen, uint8_t *dataReceived);
/**
@Summary
Gets the status of the buffer if its full.
@Description
This routine gets the status of the buffer if its full.
@Preconditions
The MSSP1_SPI_Initialize routine must have been called for the specified
MSSP1_SPI driver instance.
@Param
None.
@Returns
true - if the buffer is full
false - if the buffer is not full.
@Example
Refer to MSSP1_SPI_Initialize() for an example
*/
bool MSSP1_SPI_IsBufferFull( void );
/**
@Summary
Gets the status of write collision.
@Description
This routine gets the status of write collision.
@Preconditions
The MSSP1_SPI_Initialize routine must have been called for the specified
MSSP1_SPI driver instance.
@Param
None.
@Returns
true - if the write collision has occurred.
false - if the write collision has not occurred.
@Example
Refer to MSSP1_SPI_Initialize() for an example
*/
bool MSSP1_SPI_HasWriteCollisionOccured( void );
/**
@Summary
Gets the status of receive overflow.
@Description
This routine gets the status of receive overflow.
@Preconditions
The MSSP1_SPI_Initialize routine must have been called for the specified
MSSP1_SPI driver instance.
@Param
None.
@Returns
true - if receive overflow has occurred.
false - if receive overflow has not occurred.
@Example
Refer to MSSP1_SPI_Initialize() for an example
*/
bool MSSP1_SPI_HasReceiveOverflowOccured( void );
void SPI_slaveSelect(void);
void SPI_slaveDeselect(void);
#ifdef __cplusplus // Provide C++ Compatibility
}
#endif
#endif //_MSSP1_SPI_H
/**
End of File
*/
|
