AN1069

Using C30 Compiler and the SPI Module to Interface EEPROMs

with dsPIC33F and PIC24F

This application note is intended to serve as a

Author: Martin Kvasnicka reference for communicating with Microchip’s 25XXX
Microchip Technology Inc. series serial EEPROM devices with the use of the SPI
module featured on many dsPIC33F and PIC24F
family devices. Source code for common data transfer
INTRODUCTION modes is also provided.

The 25XXX series serial EEPROMs from Microchip Figure 1 describes the hardware schematic for the
Technology are SPI compatible and have maximum interface between Microchip’s 25XXX series devices
clock frequencies ranging from 3 MHz to 20 MHz. The and the dsPIC33F DSC or the PIC24F MCU. The
SPI module available on dsPIC33F Digital Signal schematic shows the connections necessary between
Controller and PIC24F microcontroller provide a very either controller and the serial EEPROM as tested, and
easy-to-use interface for communicating with the the software was written assuming these connections.
25XXX series devices. The largest benefit of using the The WP pin is tied to VCC because the STATUS regis-
SPI module is that the signal timings are handled ter write-protect feature is not used in the examples
through hardware rather than software. This allows the provided.
firmware to continue executing while communication is
handled in the background. This also means that an
understanding of the timing specifications associated
with the SPI protocol is not required in order to use the
25XXX series devices in designs.

FIGURE 1: CIRCUIT FOR dsPIC33FJ256GP710, PIC24FJ128GA010 AND 25XXX SERIES

DEVICE

VCC
SDA1/RG3
SCK1/INT0/RF6
100 Pin TQFP SDI1/RF7
SDO1/RF8
dsPIC33FJ256GP710 U1RX/RF2 CS 1 8 VCC
PIC24FJ128GA010 U1TX/RF3
25XXX

SO 2 7 HOLD
WP
VDD
VSS

IC7/U1CTS/CN20/RD14

U2RX/CN17/RF4
IC8/U1RTS/CN21/RD15

U2TX/CN18/RF5

3 6 SCK
VSS 4 5 SI

Note: CS, WP and HOLD pins should all have pull-up resistors (~10k-ohms).

© 2007 Microchip Technology Inc. DS01069B-page 1

AN1069
FIRMWARE DESCRIPTION
The purpose of the program is to show individual
features of the SPI protocol and give code samples of
the opcodes so that the basic building blocks of a pro-
gram can be shown. The firmware was written in C and
the Microchip C30 compiler was used. The opcodes
used in the program are Write Enable (WREN), Write,
Read, and Read Status Register (RDSR) (used in the
program for WIP polling). The oscilloscope pictures
have markers that are shown from CS enable to CS
disable for ease in reading. The data sheet version of
the waveform is below the actual oscilloscope picture.
The SPI module is set up for Mode 0,0 operation. The
code is written in modules and commented so chang-
ing modes, speeds, and modifying commands such as
sequential reads and page writes is simple. The values
represented in this application note are all hex values
unless otherwise noted.
Besides the standard SPI libraries supplied with the
C30 compiler, the firmware consists of two .c files
(AN1069.c and AN1069_spi.c), organized into nine
sections.
• Initialization
• Low Density Byte Write
• Low Density Byte Read
• Low Density Page Write
• Low Density Page Read
• High Density Byte Write
• High Density Byte Read
• High Density Page Write
• High Density Page Read
The low density routines are intended for use with the
4K and smaller density devices that use only one byte
of address (25XX010A, 25XX020A, and 25XX040A) 1,
2, and 4 Kbit devices. The Most Significant bit (A8) for
the 25XX040A device resides in the control code,
please refer to the individual data sheet for particulars.
The high density routines are intended for use with 8
Kbit and higher density devices that use two bytes of
address. This program also exhibits the WIP polling
feature for detecting the completion of write cycles after
the byte write and page write operations. Read opera-
tions are located directly after each write operation,
thus allowing for verification that the data was properly
written. No method of displaying the input data is
provided, but a SEEVAL® 32 evaluation system, an
oscilloscope, or a Microchip MPLAB® ICD 2 could be
used.
The code was tested using a 25LC256 serial
EEPROM. This device features 32k x 8 (256 Kbit) of
memory and 64-byte pages.

DS01069B-page 2 © 2007 Microchip Technology Inc.

 AN1069
INITIALIZATION TRISF Register
In order to configure the SPI module for SPI mode 0,0, In order to be properly controlled the CS pin must be
several key registers on the dsPIC33F DSC or PIC24F configured as an output. This is done by setting the
MCU need to be properly initialized. respective bit in TRISF to ‘0’ for output. The SCK, SDI
and SDO pins will automatically be configured when
SPI1STAT STATUS Register (SPI1STAT) the SPI Enable bit is set.

SPI1STAT holds all of the Status bits associated with

the SPI module. The SPI Enable bit (SPIPEN) must be
set in order to enable the serial port.

SPI1 Control Register (SPI1CON1)

SPI1CON1 is one of the Configuration registers for the
SPI module. In SPI mode 0,0, the SMP bit of the regis-
ter needs to be set for data to be sampled at the end of
the output time. The Clock Polarity Select bit (CKP)
needs to be cleared for Idle state of the clock to be a
low level. The MSTEN bit needs to be set for “Master”
mode. Finally, the Secondary Prescale bits (SPRE) and
the Primary Prescale bits (PPRE) are configured, in
this case, 2:1 (Secondary) and 1:1 (Primary).
SPI1CON2 is used for “framed” SPI support, is not
used in the code here and, therefore, is cleared during
initialization.

© 2007 Microchip Technology Inc. DS01069B-page 3

AN1069
WRITE ENABLE
Figure 2 shows an example of the Write Enable
command. Chip Select is brought low (active) and the
opcode is sent out through the SPI port. The Write
Enable command must be given before a write is
attempted to either the array or the STATUS register.
The WEL bit can be cleared by issuing a Write Disable
command (WRDI) or it is automatically reset if the
device is powered down or a write cycle is completed.

FIGURE 2: WRITE ENABLE (WREN)

CS

0 1 2 3 4 5 6 7
SCK

SI 0 0 0 0 0 1 1 0

High-Impedance
SO

DS01069B-page 4 © 2007 Microchip Technology Inc.

 AN1069
READ STATUS REGISTER TO CHECK Once again the device is selected and the opcode,
0x05, is sent. The STATUS register is shifted out on the
FOR WEL BIT
Serial Out pin. A value of 0x02 shows that the WEL bit
Figure 3 shows an example of the Read Status in the STATUS register has been set. The device is now
Register command to check for the WEL bit. The WEL ready to do a write to either the STATUS register or the
bit must be set before a write is attempted to either the array.
STATUS register or the array. It is good programming
practice to check whether this bit is set before
attempting the write.

FIGURE 3: READ STATUS REGISTER TO CHECK FOR WEL BIT (RDSR)

CS

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

SCK

Instruction

SI 0 0 0 0 0 1 0 1

Data from STATUS Register

High-Impedance
SO 7 6 5 4 3 2 1 0

© 2007 Microchip Technology Inc. DS01069B-page 5

AN1069
BYTE WRITE COMMAND (OPCODE, A page write can be accomplished by continuing to give
data bytes to the device without toggling CS. Up to one
ADDRESS AND DATA) full page (64 bytes for the 25XX256) can be written
Figure 4 shows an example of the Write command. For before a write cycle is needed. Once CS is brought high
this, the device is selected and the opcode, 0x02, is after the data bytes have been transmitted, then the
sent. The High Address byte is given 0x00, followed by write cycle timer will begin and normal polling can be
the Low Address byte, 0x10. Finally, the data is clocked initiated. The included page write function programs all
in last, in this case, 0xA5. Once the Chip Select is tog- 64 bytes of data in the first page. Since the starting
gled at the end of this command, the internal write cycle address is 0x0010, the last 16 bytes of data will wrap
is initiated. Once the internal write cycle has begun, the from address 0x003F to address 0x0000 and complete
WIP bit in the STATUS register can now be polled to the page. Caution should be taken when initiating
check when the write finishes or a delay needs to be writes in this manner so that previously stored data
added (~5ms), if the WIP bit is not being polled. This doesn’t get overwritten.
code uses WIP polling.

FIGURE 4: BYTE WRITE COMMAND, ADDRESS AND DATA

CS
Twc
0 1 2 3 4 5 6 7 8 9 10 11 21 22 23 24 25 26 27 28 29 30 31
SCK
Instruction 16-bit Address Data Byte
SI 0 0 0 0 0 0 1 0 15 14 13 12 2 1 0 7 6 5 4 3 2 1 0

High-Impedance
SO

DS01069B-page 6 © 2007 Microchip Technology Inc.

 AN1069
DATA POLLING (RDSR – CHECK FOR
WIP SET)
After a valid Write command is given, the STATUS
register can be read to check if the internal write cycle
has been initiated, and it can continuously be moni-
tored to look for the end of the write cycle. In this case,
the device is selected and the opcode, 0x05, is sent.
The STATUS register is then shifted out on the Data
Out pin, resulting in a value of 0x03. Figure 5 shows
that both the WEL bit (bit 1) and the WIP bit (bit 0) are
set, meaning the write cycle is in progress.

FIGURE 5: DATA POLLING (READ STATUS REGISTER TO CHECK WIP BIT)

CS

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

SCK

Instruction

SI 0 0 0 0 0 1 0 1

Data from STATUS Register

High-Impedance
SO 7 6 5 4 3 2 1 0

© 2007 Microchip Technology Inc. DS01069B-page 7

AN1069
DATA POLLING FINISHED This indicates that the write cycle has finished and the
device is now ready for additional commands. The
(RDSR – WIP BIT CLEARED)
WEL bit is also cleared at the end of a write cycle,
The part remains in a continuous RDSR loop and the which serves as additional protection against
WIP status is evaluated until the bit is cleared. Figure 6 unwanted writes.
shows the Status Register Read command followed by
a value of 0x00 being shifted out on the Data Out pin.

FIGURE 6: DATA POLLING FINISHED (RDSR – WIP AND WEL BITS CLEARED)

CS

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

SCK

Instruction

SI 0 0 0 0 0 1 0 1

Data from STATUS Register

High-Impedance
SO 7 6 5 4 3 2 1 0

DS01069B-page 8 © 2007 Microchip Technology Inc.

 AN1069
READ COMMAND (OPCODE, out on the Serial Out pin, in this case, 0xA5. In order to
do a sequential read, more clocks need to be gener-
ADDRESS AND DATA)
ated. It is possible to read the entire chip by continuing
Figure 7 shows an example of the Read command. For to provide clocks to the device. Once the end of the
this, the device is selected and the opcode, 0x03, is array is reached, the data will wrap to the beginning of
sent. The High Address byte is given 0x00, followed by the array (Address 0x0000) and keep reading out until
the Low Address byte, 0x10. Finally, the data is clocked CS is deselected or clocks stop being provided.

FIGURE 7: READ COMMAND, ADDRESS AND DATA

CS

0 1 2 3 4 5 6 7 8 9 10 11 21 22 23 24 25 26 27 28 29 30 31
SCK

Instruction 16-bit Address

SI 0 0 0 0 0 0 1 1 15 14 13 12 2 1 0

Data Out
High-Impedance
SO 7 6 5 4 3 2 1 0

© 2007 Microchip Technology Inc. DS01069B-page 9

AN1069
CHANGING PROCESSORS CONCLUSION
This application note code was written to simplify These are some of the basic features of SPI communi-
changing between processors. There are, however, a cations using the SPI module on one of Microchip’s
couple of steps that need to be taken in order to do this. dsPIC33F devices. The code is highly portable and can
This application note was tested with two specific be used on many devices that have the SPI module
processors, the dsPIC33FJ256GP710 and the with very minor modifications. Using the code provided,
PIC24FJ128GA010. If you are going to use processors designers can begin to build their own SPI libraries to
that are different from these two, please consult the be as simple or complex as needed. The code was
device-specific data sheet to check for any other poten- tested on Microchip’s Explorer 16 Development Board
tial issues when using this code. As mentioned previ- with the connections shown in Figure 1.
ously, the Explorer 16 development board was used for
this application note with the connections shown in
Figure 1. In order to change between these processors
there are four steps:
1. The current processor module currently on the
Explorer 16 board must be physically replaced
with the processor module desired. Be sure to
disconnect power during this procedure.
2. The #define statements on lines 30 and 31 in the
an1096.h file must be commented in/out for the
desired processor.
3. The new processor needs to be selected in the
MPLAB® IDE by going to Configure>Select
Device...
4. The linker file needs to be added/removed for
the desired processor. If this is not done, it will
not prevent the code from compiling but will
remove some undesired warnings from the
compiler.

DS01069B-page 10 © 2007 Microchip Technology Inc.

Note the following details of the code protection feature on Microchip devices:
• Microchip products meet the specification contained in their particular Microchip Data Sheet.

• Microchip believes that its family of products is one of the most secure families of its kind on the market today, when used in the
intended manner and under normal conditions.

• There are dishonest and possibly illegal methods used to breach the code protection feature. All of these methods, to our
knowledge, require using the Microchip products in a manner outside the operating specifications contained in Microchip’s Data
Sheets. Most likely, the person doing so is engaged in theft of intellectual property.

• Microchip is willing to work with the customer who is concerned about the integrity of their code.

• Neither Microchip nor any other semiconductor manufacturer can guarantee the security of their code. Code protection does not
mean that we are guaranteeing the product as “unbreakable.”

Code protection is constantly evolving. We at Microchip are committed to continuously improving the code protection features of our
products. Attempts to break Microchip’s code protection feature may be a violation of the Digital Millennium Copyright Act. If such acts
allow unauthorized access to your software or other copyrighted work, you may have a right to sue for relief under that Act.

Information contained in this publication regarding device Trademarks

applications and the like is provided only for your convenience
The Microchip name and logo, the Microchip logo, Accuron,
and may be superseded by updates. It is your responsibility to
dsPIC, KEELOQ, KEELOQ logo, microID, MPLAB, PIC,
ensure that your application meets with your specifications.
PICmicro, PICSTART, PRO MATE, rfPIC and SmartShunt are
MICROCHIP MAKES NO REPRESENTATIONS OR
registered trademarks of Microchip Technology Incorporated
WARRANTIES OF ANY KIND WHETHER EXPRESS OR
in the U.S.A. and other countries.
IMPLIED, WRITTEN OR ORAL, STATUTORY OR
OTHERWISE, RELATED TO THE INFORMATION, AmpLab, FilterLab, Linear Active Thermistor, Migratable
INCLUDING BUT NOT LIMITED TO ITS CONDITION, Memory, MXDEV, MXLAB, SEEVAL, SmartSensor and The
QUALITY, PERFORMANCE, MERCHANTABILITY OR Embedded Control Solutions Company are registered
FITNESS FOR PURPOSE. Microchip disclaims all liability trademarks of Microchip Technology Incorporated in the
arising from this information and its use. Use of Microchip U.S.A.
devices in life support and/or safety applications is entirely at Analog-for-the-Digital Age, Application Maestro, CodeGuard,
the buyer’s risk, and the buyer agrees to defend, indemnify and dsPICDEM, dsPICDEM.net, dsPICworks, dsSPEAK, ECAN,
hold harmless Microchip from any and all damages, claims, ECONOMONITOR, FanSense, FlexROM, fuzzyLAB,
suits, or expenses resulting from such use. No licenses are In-Circuit Serial Programming, ICSP, ICEPIC, Mindi, MiWi,
conveyed, implicitly or otherwise, under any Microchip MPASM, MPLAB Certified logo, MPLIB, MPLINK, PICkit,
intellectual property rights. PICDEM, PICDEM.net, PICLAB, PICtail, PowerCal,
PowerInfo, PowerMate, PowerTool, REAL ICE, rfLAB, Select
Mode, Smart Serial, SmartTel, Total Endurance, UNI/O,
WiperLock and ZENA are trademarks of Microchip
Technology Incorporated in the U.S.A. and other countries.
SQTP is a service mark of Microchip Technology Incorporated
in the U.S.A.
All other trademarks mentioned herein are property of their
respective companies.
© 2007, Microchip Technology Incorporated, Printed in the
U.S.A., All Rights Reserved.
Printed on recycled paper.

Microchip received ISO/TS-16949:2002 certification for its worldwide

headquarters, design and wafer fabrication facilities in Chandler and
Tempe, Arizona; Gresham, Oregon and design centers in California
and India. The Company’s quality system processes and procedures
are for its PIC® MCUs and dsPIC® DSCs, KEELOQ® code hopping
devices, Serial EEPROMs, microperipherals, nonvolatile memory and
analog products. In addition, Microchip’s quality system for the design
and manufacture of development systems is ISO 9001:2000 certified.

© 2007 Microchip Technology Inc. DS01069B-page 11

 WORLDWIDE SALES AND SERVICE
AMERICAS ASIA/PACIFIC ASIA/PACIFIC EUROPE
Corporate Office Asia Pacific Office India - Bangalore Austria - Wels
2355 West Chandler Blvd. Suites 3707-14, 37th Floor Tel: 91-80-4182-8400 Tel: 43-7242-2244-39
Chandler, AZ 85224-6199 Tower 6, The Gateway Fax: 91-80-4182-8422 Fax: 43-7242-2244-393
Tel: 480-792-7200 Harbour City, Kowloon Denmark - Copenhagen
India - New Delhi
Fax: 480-792-7277 Hong Kong Tel: 45-4450-2828
Tel: 91-11-4160-8631
Technical Support: Tel: 852-2401-1200 Fax: 45-4485-2829
Fax: 91-11-4160-8632
http://support.microchip.com Fax: 852-2401-3431
India - Pune France - Paris
Web Address:
Australia - Sydney Tel: 91-20-2566-1512 Tel: 33-1-69-53-63-20
www.microchip.com
Tel: 61-2-9868-6733 Fax: 91-20-2566-1513 Fax: 33-1-69-30-90-79
Atlanta Fax: 61-2-9868-6755
Japan - Yokohama Germany - Munich
Duluth, GA
China - Beijing Tel: 49-89-627-144-0
Tel: 678-957-9614 Tel: 81-45-471- 6166
Tel: 86-10-8528-2100 Fax: 49-89-627-144-44
Fax: 678-957-1455 Fax: 81-45-471-6122
Fax: 86-10-8528-2104 Italy - Milan
Boston Korea - Daegu
China - Chengdu Tel: 39-0331-742611
Westborough, MA Tel: 82-53-744-4301
Tel: 86-28-8665-5511 Fax: 39-0331-466781
Tel: 774-760-0087 Fax: 82-53-744-4302
Fax: 86-28-8665-7889 Netherlands - Drunen
Fax: 774-760-0088 Korea - Seoul
China - Fuzhou Tel: 82-2-554-7200 Tel: 31-416-690399
Chicago
Tel: 86-591-8750-3506 Fax: 82-2-558-5932 or Fax: 31-416-690340
Itasca, IL
Tel: 630-285-0071 Fax: 86-591-8750-3521 82-2-558-5934 Spain - Madrid
Fax: 630-285-0075 China - Hong Kong SAR Tel: 34-91-708-08-90
Malaysia - Kuala Lumpur
Tel: 852-2401-1200 Tel: 60-3-6201-9857 Fax: 34-91-708-08-91
Dallas
Addison, TX Fax: 852-2401-3431 Fax: 60-3-6201-9859 UK - Wokingham
Tel: 972-818-7423 China - Nanjing Tel: 44-118-921-5869
Malaysia - Penang
Fax: 972-818-2924 Tel: 86-25-8473-2460 Fax: 44-118-921-5820
Tel: 60-4-227-8870
Detroit Fax: 86-25-8473-2470 Fax: 60-4-227-4068
Farmington Hills, MI China - Qingdao Philippines - Manila
Tel: 248-538-2250 Tel: 86-532-8502-7355 Tel: 63-2-634-9065
Fax: 248-538-2260 Fax: 86-532-8502-7205 Fax: 63-2-634-9069
Kokomo China - Shanghai Singapore
Kokomo, IN Tel: 86-21-5407-5533 Tel: 65-6334-8870
Tel: 765-864-8360 Fax: 86-21-5407-5066 Fax: 65-6334-8850
Fax: 765-864-8387
China - Shenyang Taiwan - Hsin Chu
Los Angeles Tel: 86-24-2334-2829 Tel: 886-3-572-9526
Mission Viejo, CA Fax: 86-24-2334-2393 Fax: 886-3-572-6459
Tel: 949-462-9523
China - Shenzhen Taiwan - Kaohsiung
Fax: 949-462-9608
Tel: 86-755-8203-2660 Tel: 886-7-536-4818
Santa Clara Fax: 86-755-8203-1760 Fax: 886-7-536-4803
Santa Clara, CA
China - Shunde Taiwan - Taipei
Tel: 408-961-6444
Tel: 86-757-2839-5507 Tel: 886-2-2500-6610
Fax: 408-961-6445
Fax: 86-757-2839-5571 Fax: 886-2-2508-0102
Toronto
China - Wuhan Thailand - Bangkok
Mississauga, Ontario,
Tel: 86-27-5980-5300 Tel: 66-2-694-1351
Canada
Fax: 86-27-5980-5118 Fax: 66-2-694-1350
Tel: 905-673-0699
Fax: 905-673-6509 China - Xian
Tel: 86-29-8833-7252
Fax: 86-29-8833-7256

10/05/07

DS01069B-page 12 © 2007 Microchip Technology Inc.