Subversion Repositories Code-Repo

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
202 Kevin 1
#include <xc.h>
2
#include "main.h"
3
#include "I2C.h"
4
 
5
static I2C_DATA *data_ptr;
6
 
7
// Set up the data structures for the base_I2C.code
8
// Should be called once before any i2c routines are called
9
void I2C_Init(I2C_DATA *data) {
10
    data_ptr = data;
11
 
12
    I2C_CLK_TRIS = 1;
13
    I2C_DAT_TRIS = 1;
14
 
15
    data_ptr->buffer_in_len = 0;
16
    data_ptr->buffer_in_len_tmp = 0;
17
    data_ptr->buffer_in_read_ind = 0;
18
    data_ptr->buffer_in_write_ind = 0;
19
 
20
    data_ptr->buffer_out_ind = 0;
21
    data_ptr->buffer_out_len = 0;
22
 
23
    data_ptr->operating_mode = 0;
24
    data_ptr->operating_state = I2C_IDLE;
25
    data_ptr->return_status = 0;
26
 
27
    data_ptr->slave_in_last_byte = 0;
28
    data_ptr->slave_sending_data = 0;
29
 
30
    data_ptr->master_dest_addr = 0;
31
    data_ptr->master_status = I2C_MASTER_IDLE;
32
 
33
    // Enable I2C interrupt
34
    PIE1bits.SSP1IE = 1;
35
}
36
 
37
// Setup the PIC to operate as a master.
38
void I2C_Configure_Master(char speed) {
39
    data_ptr->operating_mode = I2C_MODE_MASTER;
40
 
41
    SSP1STAT = 0x0;
42
    SSP1CON1 = 0x0;
43
    SSP1CON2 = 0x0;
44
    SSP1CON3 = 0x0;
45
    SSP1CON1bits.SSPM = 0x8; // I2C Master Mode
46
    if (speed) {
47
        SSP1ADD = 0x4F;      // Operate at 100KHz (32MHz)
48
    } else {
49
        SSP1ADD = 0x13;     // Operate at 400KHz (32MHz)
50
    }
51
    SSP1STATbits.SMP = 1;   // Disable Slew Rate Control
52
    SSP1CON3bits.PCIE = 1;  // Stop condition interrupt enable
53
    SSP1CON3bits.SCIE = 1;  // Start condition interrupt enable
54
    SSP1CON1bits.SSPEN = 1; // Enable MSSP Module
55
}
56
 
57
// Sends length number of bytes in msg to specified address (no R/W bit)
58
void I2C_Master_Send(char address, char length, char *msg) {
59
    char i;
60
    if (length == 0)
61
        return;
62
 
63
    // Copy message to send into buffer and save length/address
64
    for (i = 0; i < length; i++) {
65
        data_ptr->buffer_in[i] = msg[i];
66
    }
67
    data_ptr->buffer_in_len = length;
68
    data_ptr->master_dest_addr = address;
69
    data_ptr->buffer_in_read_ind = 0;
70
    data_ptr->buffer_in_write_ind = 0;
71
 
72
    // Change status to 'next' operation
73
    data_ptr->operating_state = I2C_SEND_ADDR;
74
    data_ptr->master_status = I2C_MASTER_SEND;
75
 
76
    // Generate start condition
77
    SSP1CON2bits.SEN = 1;
78
}
79
 
80
// Reads length number of bytes from address (no R/W bit)
81
void I2C_Master_Recv(char address, char length) {
82
    if (length == 0)
83
        return;
84
 
85
    // Save length and address to get data from
86
    data_ptr->buffer_in_len = length;
87
    data_ptr->master_dest_addr = address;
88
    data_ptr->buffer_in_read_ind = 0;
89
    data_ptr->buffer_in_write_ind = 0;
90
 
91
    // Change status to 'next' operation
92
    data_ptr->operating_state = I2C_SEND_ADDR;
93
    data_ptr->master_status = I2C_MASTER_RECV;
94
 
95
    // Generate start condition
96
    SSP1CON2bits.SEN = 1;
97
}
98
 
99
// Writes msg to address then reads length number of bytes from address
100
void I2C_Master_Restart(char address, char msg, char length) {
101
    char c;
102
    if (length == 0) {
103
        c = msg;
104
        I2C_Master_Send(address, 1, &c);
105
        return;
106
    }
107
 
108
    // Save length and address to get data from
109
    data_ptr->buffer_in[0] = msg;
110
    data_ptr->buffer_in_len = length;
111
    data_ptr->master_dest_addr = address;
112
    data_ptr->buffer_in_read_ind = 0;
113
    data_ptr->buffer_in_write_ind = 0;
114
 
115
    // Change status to 'next' operation
116
    data_ptr->operating_state = I2C_SEND_ADDR;
117
    data_ptr->master_status = I2C_MASTER_RESTART;
118
 
119
    // Generate start condition
120
    SSP1CON2bits.SEN = 1;
121
}
122
 
123
// Setup the PIC to operate as a slave. The address must not include the R/W bit
124
void I2C_Configure_Slave(char addr) {
125
    data_ptr->operating_mode = I2C_MODE_SLAVE;
126
 
127
    SSP1ADD = addr << 1;     // Set the slave address
128
 
129
    SSP1STAT = 0x0;
130
    SSP1CON1 = 0x0;
131
    SSP1CON2 = 0x0;
132
    SSP1CON3 = 0x0;
133
    SSP1CON1bits.SSPM = 0xE; // Enable Slave 7-bit w/ start/stop interrupts
134
    SSP1STATbits.SMP = 1;    // Slew Off
135
    SSP1CON2bits.SEN = 1;    // Enable clock-stretching
136
    SSP1CON1bits.SSPEN = 1;  // Enable MSSP Module
137
}
138
 
139
void I2C_Interrupt_Handler() {
140
    // Call interrupt depending on which mode we are operating in
141
    if (data_ptr->operating_mode == I2C_MODE_MASTER) {
142
        I2C_Interrupt_Master();
143
    } else if (data_ptr->operating_mode == I2C_MODE_SLAVE) {
144
        I2C_Interrupt_Slave();
145
    }
146
}
147
 
148
// An internal subroutine used in the master version of the i2c_interrupt_handler
149
void I2C_Interrupt_Master() {
150
    // If we are in the middle of sending data
151
    if (data_ptr->master_status == I2C_MASTER_SEND) {
152
        switch (data_ptr->operating_state) {
153
            case I2C_IDLE:
154
                break;
155
            case I2C_SEND_ADDR:
156
                // Send the address with read bit set
157
                data_ptr->operating_state = I2C_CHECK_ACK_SEND;
158
                SSP1BUF = (data_ptr->master_dest_addr << 1) | 0x0;
159
                break;
160
            case I2C_CHECK_ACK_SEND:
161
                // Check if ACK is received or not
162
                if (!SSP1CON2bits.ACKSTAT) {
163
                    // If an ACK is received, send next byte of data
164
                    if (data_ptr->buffer_in_read_ind < data_ptr->buffer_in_len) {
165
                        SSP1BUF = data_ptr->buffer_in[data_ptr->buffer_in_read_ind];
166
                        data_ptr->buffer_in_read_ind++;
167
                    } else {
168
                        // If no more data is to be sent, send stop bit
169
                        data_ptr->operating_state = I2C_IDLE;
170
                        SSP1CON2bits.PEN = 1;
171
                        data_ptr->master_status = I2C_MASTER_IDLE;
172
                        data_ptr->return_status = I2C_SEND_OK;
173
                    }
174
                } else {
175
                    // If a NACK is received, stop transmission and send error
176
                    data_ptr->operating_state = I2C_IDLE;
177
                    SSP1CON2bits.PEN = 1;
178
                    data_ptr->master_status = I2C_MASTER_IDLE;
179
                    data_ptr->return_status = I2C_SEND_FAIL;
180
                }
181
                break;
182
        }
183
    // If we are in the middle of receiving data
184
    } else if (data_ptr->master_status == I2C_MASTER_RECV) {
185
        switch (data_ptr->operating_state) {
186
            case I2C_IDLE:
187
                break;
188
            case I2C_SEND_ADDR:
189
                // Send address with write bit set
190
                data_ptr->operating_state = I2C_CHECK_ACK_RECV;
191
                SSP1BUF = (data_ptr->master_dest_addr << 1) | 0x1;
192
                break;
193
            case I2C_CHECK_ACK_RECV:
194
                // Check if ACK is received
195
                if (!SSP1CON2bits.ACKSTAT) {
196
                    // If an ACK is received, set module to receive 1 byte of data
197
                    data_ptr->operating_state = I2C_RCV_DATA;
198
                    SSP1CON2bits.RCEN = 1;
199
                } else {
200
                    // If a NACK is received, stop transmission and send error
201
                    data_ptr->operating_state = I2C_IDLE;
202
                    SSP1CON2bits.PEN = 1;
203
                    data_ptr->master_status = I2C_MASTER_IDLE;
204
                    data_ptr->return_status = I2C_RECV_FAIL;
205
                }
206
                break;
207
            case I2C_RCV_DATA:
208
                // On receive, save byte into buffer
209
                // TODO: Handle I2C buffer overflow
210
                data_ptr->buffer_in[data_ptr->buffer_in_write_ind] = SSP1BUF;
211
                data_ptr->buffer_in_write_ind++;
212
                if (data_ptr->buffer_in_write_ind < data_ptr->buffer_in_len) {
213
                    // If we still need to read, send an ACK to the slave
214
                    data_ptr->operating_state = I2C_REQ_DATA;
215
                    SSP1CON2bits.ACKDT = 0;  // ACK
216
                    SSP1CON2bits.ACKEN = 1;
217
                } else {
218
                    // If we are done reading, send an NACK to the slave
219
                    data_ptr->operating_state = I2C_SEND_STOP;
220
                    SSP1CON2bits.ACKDT = 1;  // NACK
221
                    SSP1CON2bits.ACKEN = 1;
222
                }
223
                break;
224
            case I2C_REQ_DATA:
225
                // Set module to receive one byte of data
226
                data_ptr->operating_state = I2C_RCV_DATA;
227
                SSP1CON2bits.RCEN = 1;
228
                break;
229
            case I2C_SEND_STOP:
230
                // Send the stop bit and copy message to send to Main()
231
                data_ptr->operating_state = I2C_IDLE;
232
                SSP1CON2bits.PEN = 1;
233
                data_ptr->master_status = I2C_MASTER_IDLE;
234
                data_ptr->return_status = I2C_RECV_OK;
235
                break;
236
        }
237
    } else if (data_ptr->master_status == I2C_MASTER_RESTART) {
238
        switch (data_ptr->operating_state) {
239
            case I2C_IDLE:
240
                break;
241
            case I2C_SEND_ADDR:
242
                // Send the address with read bit set
243
                data_ptr->operating_state = I2C_CHECK_ACK_SEND;
244
                SSP1BUF = (data_ptr->master_dest_addr << 1) | 0x0;
245
                break;
246
            case I2C_CHECK_ACK_SEND:
247
                // Check if ACK is received or not
248
                if (!SSP1CON2bits.ACKSTAT) {
249
                    // If an ACK is received, send first byte of data
250
                    SSP1BUF = data_ptr->buffer_in[0];
251
                    data_ptr->operating_state = I2C_CHECK_ACK_RESTART;
252
                } else {
253
                    // If a NACK is received, stop transmission and send error
254
                    data_ptr->operating_state = I2C_IDLE;
255
                    SSP1CON2bits.PEN = 1;
256
                    data_ptr->master_status = I2C_MASTER_IDLE;
257
                    data_ptr->return_status = I2C_SEND_FAIL;
258
                }
259
                break;
260
            case I2C_CHECK_ACK_RESTART:
261
                if (!SSP1CON2bits.ACKSTAT) {
262
                    SSP1CON2bits.RSEN = 1;
263
                    data_ptr->operating_state = I2C_SEND_ADDR_2;
264
                } else {
265
                    // If a NACK is received, stop transmission and send error
266
                    data_ptr->operating_state = I2C_IDLE;
267
                    SSP1CON2bits.PEN = 1;
268
                    data_ptr->master_status = I2C_MASTER_IDLE;
269
                    data_ptr->return_status = I2C_SEND_FAIL;
270
                }
271
                break;
272
            case I2C_SEND_ADDR_2:
273
                // Send the address with read bit set
274
                data_ptr->operating_state = I2C_CHECK_ACK_RECV;
275
                SSP1BUF = (data_ptr->master_dest_addr << 1) | 0x1;
276
                break;
277
            case I2C_CHECK_ACK_RECV:
278
                // Check if ACK is received
279
                if (!SSP1CON2bits.ACKSTAT) {
280
                    // If an ACK is received, set module to receive 1 byte of data
281
                    data_ptr->operating_state = I2C_RCV_DATA;
282
                    SSP1CON2bits.RCEN = 1;
283
                } else {
284
                    // If a NACK is received, stop transmission and send error
285
                    data_ptr->operating_state = I2C_IDLE;
286
                    SSP1CON2bits.PEN = 1;
287
                    data_ptr->master_status = I2C_MASTER_IDLE;
288
                    data_ptr->return_status = I2C_RECV_FAIL;
289
                }
290
                break;
291
            case I2C_RCV_DATA:
292
                // On receive, save byte into buffer
293
                // TODO: Handle I2C buffer overflow
294
                data_ptr->buffer_in[data_ptr->buffer_in_write_ind] = SSP1BUF;
295
                data_ptr->buffer_in_write_ind++;
296
                if (data_ptr->buffer_in_write_ind < data_ptr->buffer_in_len) {
297
                    // If we still need to read, send an ACK to the slave
298
                    data_ptr->operating_state = I2C_REQ_DATA;
299
                    SSP1CON2bits.ACKDT = 0;  // ACK
300
                    SSP1CON2bits.ACKEN = 1;
301
                } else {
302
                    // If we are done reading, send an NACK to the slave
303
                    data_ptr->operating_state = I2C_SEND_STOP;
304
                    SSP1CON2bits.ACKDT = 1;  // NACK
305
                    SSP1CON2bits.ACKEN = 1;
306
                }
307
                break;
308
            case I2C_REQ_DATA:
309
                // Set module to receive one byte of data
310
                data_ptr->operating_state = I2C_RCV_DATA;
311
                SSP1CON2bits.RCEN = 1;
312
                break;
313
            case I2C_SEND_STOP:
314
                // Send the stop bit and copy message to send to Main()
315
                data_ptr->operating_state = I2C_IDLE;
316
                SSP1CON2bits.PEN = 1;
317
                data_ptr->master_status = I2C_MASTER_IDLE;
318
                data_ptr->return_status = I2C_RECV_OK;
319
                break;
320
        }
321
    }
322
}
323
 
324
void I2C_Interrupt_Slave() {
325
    char received_data;
326
    char data_read_from_buffer = 0;
327
    char data_written_to_buffer = 0;
328
    char overrun_error = 0;
329
 
330
    // Clear SSPOV (overflow bit)
331
    if (SSP1CON1bits.SSPOV == 1) {
332
        SSP1CON1bits.SSPOV = 0;
333
        // We failed to read the buffer in time, so we know we
334
        //  can't properly receive this message, just put us in the
335
        //  a state where we are looking for a new message
336
        data_ptr->operating_state = I2C_IDLE;
337
        overrun_error = 1;
338
        data_ptr->return_status = I2C_ERR_OVERRUN;
339
    }
340
 
341
    // Read SPPxBUF if it is full
342
    if (SSP1STATbits.BF == 1) {
343
        received_data = SSP1BUF;
344
        data_read_from_buffer = 1;
345
    }
346
 
347
    if (!overrun_error) {
348
        switch (data_ptr->operating_state) {
349
            case I2C_IDLE:
350
            {
351
                // Ignore anything except a start
352
                if (SSP1STATbits.S == 1) {
353
                    data_ptr->buffer_in_len_tmp = 0;
354
                    data_ptr->operating_state = I2C_STARTED;
355
//                    if (data_read_from_buffer) {
356
//                        if (SSPSTATbits.D_A == 1) {
357
//                            DBG_PRINT_I2C("I2C Start: (ERROR) no address recieved\r\n");
358
//                            // This is bad because we got data and we wanted an address
359
//                            data_ptr->operating_state = I2C_IDLE;
360
//                            data_ptr->return_status = I2C_ERR_NOADDR;
361
//                        } else {
362
//                            // Determine if we are sending or receiving data
363
//                            if (SSPSTATbits.R_W == 1) {
364
//                                data_ptr->operating_state = I2C_SEND_DATA;
365
//                            } else {
366
//                                data_ptr->operating_state = I2C_RCV_DATA;
367
//                            }
368
//                        }
369
//                    } else {
370
//                        data_ptr->operating_state = I2C_STARTED;
371
//                    }
372
                }
373
                break;
374
            }
375
            case I2C_STARTED:
376
            {
377
                // In this case, we expect either an address or a stop bit
378
                if (SSP1STATbits.P == 1) {
379
                    // Return to idle mode
380
                    data_ptr->operating_state = I2C_IDLE;
381
                } else if (data_read_from_buffer) {
382
                    if (SSP1STATbits.D_nA == 0) {
383
                        // Address received
384
                        if (SSP1STATbits.R_nW == 0) {
385
                            // Slave write mode
386
                            data_ptr->operating_state = I2C_RCV_DATA;
387
                        } else {
388
                            // Slave read mode
389
                            data_ptr->operating_state = I2C_SEND_DATA;
390
                            // Process the first byte immediatly if sending data
391
                            goto send;
392
                        }
393
                    } else {
394
                        data_ptr->operating_state = I2C_IDLE;
395
                        data_ptr->return_status = I2C_ERR_NODATA;
396
                    }
397
                }
398
                break;
399
            }
400
            send:
401
            case I2C_SEND_DATA:
402
            {
403
                if (!data_ptr->slave_sending_data) {
404
                    // If we are not currently sending data, figure out what to reply with
405
                    if (I2C_Process_Send(data_ptr->slave_in_last_byte)) {
406
                        // Data exists to be returned, send first byte
407
                        SSP1BUF = data_ptr->buffer_out[0];
408
                        data_ptr->buffer_out_ind = 1;
409
                        data_ptr->slave_sending_data = 1;
410
                        data_written_to_buffer = 1;
411
                    } else {
412
                        // Unknown request
413
                        data_ptr->slave_sending_data = 0;
414
                        data_ptr->operating_state = I2C_IDLE;
415
                    }
416
                } else {
417
                    // Sending remaining data back to master
418
                    if (data_ptr->buffer_out_ind < data_ptr->buffer_out_len) {
419
                        SSP1BUF = data_ptr->buffer_out[data_ptr->buffer_out_ind];
420
                        data_ptr->buffer_out_ind++;
421
                        data_written_to_buffer = 1;
422
                    } else {
423
                        // Nothing left to send
424
                        data_ptr->slave_sending_data = 0;
425
                        data_ptr->operating_state = I2C_IDLE;
426
                    }
427
                }
428
                break;
429
            }
430
            case I2C_RCV_DATA:
431
            {
432
                // We expect either data or a stop bit or a (if a restart, an addr)
433
                if (SSP1STATbits.P == 1) {
434
                    // Stop bit detected, we need to check to see if we also read data
435
                    if (data_read_from_buffer) {
436
                        if (SSP1STATbits.D_nA == 1) {
437
                            // Data received with stop bit
438
                            // TODO: Handle I2C buffer overflow
439
                            data_ptr->buffer_in[data_ptr->buffer_in_write_ind] = received_data;
440
                            if (data_ptr->buffer_in_write_ind == I2C_BUFFER_SIZE-1) {
441
                                data_ptr->buffer_in_write_ind = 0;
442
                            } else {
443
                                data_ptr->buffer_in_write_ind++;
444
                            }
445
                            data_ptr->buffer_in_len_tmp++;
446
                            // Save the last byte received
447
                            data_ptr->slave_in_last_byte = received_data;
448
                            data_ptr->return_status = I2C_DATA_AVAL;
449
                        } else {
450
                            data_ptr->operating_state = I2C_IDLE;
451
                            data_ptr->return_status = I2C_ERR_NODATA;
452
                        }
453
                    }
454
                    data_ptr->buffer_in_len += data_ptr->buffer_in_len_tmp;
455
                    data_ptr->operating_state = I2C_IDLE;
456
                } else if (data_read_from_buffer) {
457
                    if (SSP1STATbits.D_nA == 1) {
458
                        // Data received
459
                        data_ptr->buffer_in[data_ptr->buffer_in_write_ind] = received_data;
460
                        if (data_ptr->buffer_in_write_ind == I2C_BUFFER_SIZE-1) {
461
                            data_ptr->buffer_in_write_ind = 0;
462
                        } else {
463
                            data_ptr->buffer_in_write_ind++;
464
                        }
465
                        data_ptr->buffer_in_len_tmp++;
466
                        // Save the last byte received
467
                        data_ptr->slave_in_last_byte = received_data;
468
                        data_ptr->return_status = I2C_DATA_AVAL;
469
                    } else {
470
                        // Restart bit detected
471
                        if (SSP1STATbits.R_nW == 1) {
472
                            data_ptr->buffer_in_len += data_ptr->buffer_in_len_tmp;
473
                            data_ptr->operating_state = I2C_SEND_DATA;
474
                            // Process the first byte immediatly if sending data
475
                            goto send;
476
                        } else {
477
                            // Bad to recv an address again, we aren't ready
478
                            data_ptr->operating_state = I2C_IDLE;
479
                            data_ptr->return_status = I2C_ERR_NODATA;
480
                        }
481
                    }
482
                }
483
                break;
484
            }
485
        }
486
    }
487
 
488
    // Release the clock stretching bit (if we should)
489
    if (data_read_from_buffer || data_written_to_buffer) {
490
        // Release the clock
491
        if (SSP1CON1bits.CKP == 0) {
492
            SSP1CON1bits.CKP = 1;
493
        }
494
    }
495
}
496
 
497
/* Returns 0 if I2C module is currently busy, otherwise returns status code */
498
char I2C_Get_Status() {
499
    if (data_ptr->operating_mode == I2C_MODE_MASTER) {
500
        if (data_ptr->master_status != I2C_MASTER_IDLE || data_ptr->buffer_in_len == 0) {
501
            return 0;
502
        } else {
503
            return data_ptr->return_status;
504
        }
505
    } else {
506
        if (data_ptr->operating_state != I2C_IDLE || data_ptr->buffer_in_len == 0) {
507
            return 0;
508
        } else {
509
            return data_ptr->return_status;
510
        }
511
    }
512
}
513
 
514
char I2C_Buffer_Len() {
515
    return data_ptr->buffer_in_len;
516
}
517
 
518
/* Returns 0 if I2C module is currently busy, otherwise returns buffer length */
519
char I2C_Read_Buffer(char *buffer) {
520
    char i = 0;
521
    while (data_ptr->buffer_in_len != 0) {
522
        buffer[i] = data_ptr->buffer_in[data_ptr->buffer_in_read_ind];
523
        i++;
524
        if (data_ptr->buffer_in_read_ind == I2C_BUFFER_SIZE-1) {
525
            data_ptr->buffer_in_read_ind = 0;
526
        } else {
527
            data_ptr->buffer_in_read_ind++;
528
        }
529
        data_ptr->buffer_in_len--;
530
    }
531
    return i;
532
}
533
 
534
/* Put data to be returned here */
535
char I2C_Process_Send(char c) {
536
    char ret = 0;
537
    switch (c) {
538
        case 0xAA:
539
            data_ptr->buffer_out[0] = 'A';
540
            data_ptr->buffer_out_len = 1;
541
            ret = 1;
542
            break;
543
        case 0xBB:
544
            data_ptr->buffer_out[0] = '1';
545
            data_ptr->buffer_out[1] = '2';
546
            data_ptr->buffer_out_len = 2;
547
            ret = 1;
548
            break;
549
    }
550
    return ret;
551
}