View source

= <span class="f_Header">Action</span> =

Configures the SPI mode of the Xmega.

<span style="font-family: Arial;">&nbsp;</span>

<span style="font-family: Arial;">&nbsp;</span>

<span style="font-family: Arial;">&nbsp;</span>

= <span class="f_Header">Syntax</span> =

<span class="f_Syntax">CONFIG SPIx&nbsp;</span>= HARD, &nbsp; MASTER = YES|NO , MODE=0-3, CLOCKDIV=div, DATA_ORDER = LSB|MSB

<span style="font-family: Arial;">&nbsp;</span>

<span style="font-family: Arial;">&nbsp;</span>

= <span class="f_Header">Remarks</span> =
<div style="padding: 0px; margin: 0px 0px 0px 4px;">
{| width="604" cellspacing="0" cellpadding="1" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 129px; border: 1px solid rgb(0, 0, 0);" | 
SPIx

| valign="top" width="100%" style="width: 466px; border: 1px solid rgb(0, 0, 0);" | 
There are 4 SPI interfaces on the Xmega. You need to specify SPIC, SPID, SPIE or SPIF for SPIx. The value must be HARD.

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 129px; border: 1px solid rgb(0, 0, 0);" | 
MASTER

| valign="top" width="100%" style="width: 466px; border: 1px solid rgb(0, 0, 0);" | 
Selects if the SPI is running in master or slave mode. Possible values&nbsp;: YES, NO, 1 or 0.

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 129px; border: 1px solid rgb(0, 0, 0);" | 
MODE

| valign="top" width="100%" style="width: 466px; border: 1px solid rgb(0, 0, 0);" | 
The mode of the SPI interface. There are 4 modes in the range from 0-3.

The mode decides weather the first edge in a clock cycles is rising or falling, and if data setup and sample is on leading or trailing edge.

&nbsp;
<div style="padding: 0px; margin: 0px;">
{| cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing: 0px;"
|- style="vertical-align: top;"
| valign="top" | 
<span style="font-weight: bold;">Mode</span>

| valign="top" | 
<span style="font-weight: bold;">Leading Edge</span>

| valign="top" | 
<span style="font-weight: bold;">Trailing Edge</span>

|- style="vertical-align: top;"
| valign="top" | 
0

| valign="top" | 
Rising, Sample

| valign="top" | 
Falling, Setup

|- style="vertical-align: top;"
| valign="top" | 
1

| valign="top" | 
Rising, Setup

| valign="top" | 
Falling, Sample

|- style="vertical-align: top;"
| valign="top" | 
2

| valign="top" | 
Falling, Sample

| valign="top" | 
Rising, Setup

|- style="vertical-align: top;"
| valign="top" | 
3

| valign="top" | 
Falling, Setup

| valign="top" | 
Rising, Sample

|}
</div>
|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 129px; border: 1px solid rgb(0, 0, 0);" | 
CLOCKDIV

| valign="top" width="100%" style="width: 466px; border: 1px solid rgb(0, 0, 0);" | 
The SPI is clocked by the system clock which is divided by a the SPI divider. If you select a division factor of 4, and the system clock is 4 MHz, then the SPI clock will be 1 MHz.

The possible values are&nbsp;:

CLK2, CLK4, CLK8, CLK16, CLK32, CLK64 and CLK128.

Some modes use the internal CLK2X bit.

&nbsp;

<span style="font-weight: bold;">In SLAVE mode, the maximum clock rate is CLK4.</span>

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 129px; border: 1px solid rgb(0, 0, 0);" | 
DATA ORDER

| valign="top" width="100%" style="width: 466px; border: 1px solid rgb(0, 0, 0);" | 
Selects if MSB or LSB is transferred first. The SPI can send the Least Significant bit (LSB) or the Most Significant Bit(MSB) first.

|- style="vertical-align: top;"
| valign="top" width="22%" style="width: 129px; border: 1px solid rgb(0, 0, 0);" | 
SS

| valign="top" width="100%" style="width: 466px; border: 1px solid rgb(0, 0, 0);" | 
Slave select option. The possible values are&nbsp;:

- NONE, the SS will not be set or used

- AUTO, the dedicated pin is used, this is portC.4 for SPIC, portD.4 for SPID, portE.4 for SPIE and portF.4 for SPIF.

|}
</div>
<span style="font-family: Arial;">&nbsp;</span>

The SPI settings for the Xmega differ from the SPI settings for normal AVR chips.

In order to be able to use the four different SPI interfaces the Xmega uses a channel which you need to OPEN.

After you have opened the device, you can send/receive data using PRINT and INPUT.

&nbsp;

There are 2 manuals available from ATMEL for every ATXMEGA Chip

&nbsp;
<div style="padding: 0px; margin: 0px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="15" | <span style="font-size: 10pt;">1.</span>
| One Family Manual like for example for a ATXMEGA128<span style="font-weight: bold;">A</span>1 it is Atmel AVR XMEGA&nbsp;<span style="font-weight: bold;">A</span>&nbsp;Manual
|}
</div><div style="padding: 0px; margin: 0px;">
{| border="0" cellpadding="0" cellspacing="0"
|- valign="baseline" style="vertical-align: baseline;"
| width="15" | <span style="font-size: 10pt;">2.</span>
| Another Manual for the single chips like for example for an ATXMEGA128A1 it is the ATxmega64A1/128A1/192A1/256A1/384A1 Manual. In this Manual you find for example the Alternate Pin Functions. So you can find which Pin MISO, MOSI etc.
|}
</div>
&nbsp;

The SS pin, MOSI and CLOCK pins are set to output mode automatic in master mode.

The SS pin is also made high. The SS pin is only configured when you have selected SS=AUTO.

&nbsp;

If you need to use a different pin for SS or when you need to switch the logic level yourself for SS, and thus you use the SS=NONE option, you must setup the SS pin, even if you do not use it yourself. You must prevent that the SS pin will be made low in input mode since that will set the SPI into SLAVE mode, even while it was in MASTER mode.

&nbsp;

When SS is in auto mode, the SS pin will be made low before each SPI transfer and be made high when the SPI transfer is finished. SS can be used when multiple slaves are used, or to synchronize data packets.

&nbsp;

[[File:Notice.jpg|left|Notice.jpg]]The pins are configured before the SPI control register is set. If you do not use the AUTO mode, you must set the pin direction and state yourself before using the CONFIG SPI. The following table shows which pins you have to set when NOT using the AUTO mode.

&nbsp;
<div style="padding: 0px; margin: 0px;">
{| cellspacing="0" cellpadding="0" border="1" style="border: 2px solid rgb(0, 0, 0); border-spacing: 0px; border-collapse: collapse;"
|- style="vertical-align: top;"
| valign="top" width="130" style="width: 130px; border: 1px solid rgb(0, 0, 0);" | 
<span style="font-weight: bold;">Pin</span>

| valign="top" width="157" style="width: 157px; border: 1px solid rgb(0, 0, 0);" | 
<span style="font-weight: bold;">Master Mode</span>

| valign="top" width="164" style="width: 164px; border: 1px solid rgb(0, 0, 0);" | 
<span style="font-weight: bold;">Slave Mode</span>

|- style="vertical-align: top;"
| valign="top" width="130" style="width: 130px; border: 1px solid rgb(0, 0, 0);" | 
MOSI

| valign="top" width="157" style="width: 157px; border: 1px solid rgb(0, 0, 0);" | 
User set

| valign="top" width="164" style="width: 164px; border: 1px solid rgb(0, 0, 0);" | 
Input

|- style="vertical-align: top;"
| valign="top" width="130" style="width: 130px; border: 1px solid rgb(0, 0, 0);" | 
MISO

| valign="top" width="157" style="width: 157px; border: 1px solid rgb(0, 0, 0);" | 
Input

| valign="top" width="164" style="width: 164px; border: 1px solid rgb(0, 0, 0);" | 
User set

|- style="vertical-align: top;"
| valign="top" width="130" style="width: 130px; border: 1px solid rgb(0, 0, 0);" | 
SCK

| valign="top" width="157" style="width: 157px; border: 1px solid rgb(0, 0, 0);" | 
User set

| valign="top" width="164" style="width: 164px; border: 1px solid rgb(0, 0, 0);" | 
Input

|- style="vertical-align: top;"
| valign="top" width="130" style="width: 130px; border: 1px solid rgb(0, 0, 0);" | 
SS

| valign="top" width="157" style="width: 157px; border: 1px solid rgb(0, 0, 0);" | 
User set

| valign="top" width="164" style="width: 164px; border: 1px solid rgb(0, 0, 0);" | 
Input

|}
</div>
&nbsp;

It is very important that you set the pin direction and level BEFORE you use the CONFIG SPI statement. This because the CONFIG SPI will enable the SPI interface and once enabled you can not change data direction/level.

&nbsp;

If you want to change pin levels , you must disable the SPI interface first by clearing bit 6&nbsp;:

&nbsp;

Spid_ctrl.6 = 0 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ' disable

Config Portd.4 = Output &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ' set direction

Set Portd.0.4 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ' set level

Spid_ctrl.6 = 1 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ' enable

<span style="font-family: Arial;">&nbsp;</span>

<span style="font-family: Arial;">&nbsp;</span>

= <span class="f_Header">See also</span> =

[[INPUT]],&nbsp;[[PRINT]],&nbsp;[[OPEN]]

[[SPIIN]]&nbsp;,&nbsp;[[SPIOUT]]&nbsp;,&nbsp;[[SPIINIT]]&nbsp;,&nbsp;[[SPI]]&nbsp;,&nbsp;[[SPIMOVE]]

<span style="font-family: Arial;">&nbsp;</span>

<span style="font-family: Arial;">&nbsp;</span>

= <span class="f_Header">Example</span> =

<br/><source lang="bascomavr">
Dim Bspivar As Byte , Ar(4) As Byte , W As Word
Bspivar = 1
Config Spic = Hard , Master = Yes , Mode = 0 , Clockdiv = Clk2 , Data_order = Msb
Config Spid = Hard , Master = Yes , Mode = 1 , Clockdiv = Clk8 , Data_order = Lsb
Config Spie = Hard , Master = Yes , Mode = 2 , Clockdiv = Clk4 , Data_order = Msb
Config Spif = Hard , Master = Yes , Mode = 3 , Clockdiv = Clk32 , Data_order = Msb
 
Open "SPIC" For Binary As #10
Open "SPID" For Binary As #11
Open "SPIE" For Binary As #12
Open "SPIF" For Binary As #13
Open "SPI" For Binary As #bspivar ' use a dynamic channel
'SPI channel only suppor PRINT and INPUT
Print #10 , "to spi" ; W
Input #10 , Ar(1) , W
Print #bspivar , W
Input #bspivar , W
</source><br/>{{Languages}}

[[Category:BASCOM Language Reference]]