doc/atmel.txt

   1 Summary
   2
   3   This document describes the correlation between publicly documented
   4   logic, I/O, and routing resources within the Atmel AT40k/94k family
   5   of chips and bits in the bitstreams needed to program them.
   6
   7   Our goal is to make this information available to the public without
   8   restriction on its use, for the purpose of creating automated tools
   9   which generate bitstreams.
  10
  11
  12 Statement of Public Knowledge
  13
  14   The Knowledge encapsulated in this document was derived by formal
  15   scientific experimentation, using only information generally
  16   available to the public.  Extreme care which has been taken to
  17   ensure that the process did not violate any copyright, trademark,
  18   trade secret, or patent statutes.  No licensing contracts or
  19   non-disclosure agreements were entered into by the parties involved
  20   in this endeavor, nor did they have access to any confidential
  21   information.
  22
  23   This document is part of the Public Domain; its authors surrender
  24   claim to copyright on it.
  25
  26
  27 Corrections
  28
  29   If you find errors in this document, please correct them and add the
  30   date and a short description of the correction to the table below.
  31   This will assist in merging changes made in disjoint derivitaves.
  32
  33     2005.08.12  [gosset]  Initial revision
  34     2006.03.12  [megacz]  Swapped {L1,L0}->W, FB->{L0,L1}, {H0->L0,H1->L1}
  35     2006.03.13  [megacz]  Fixed lowest bit of z=00000000; it should be "1"
  36     2006.03.13  [megacz]  Corrected meaning of z-octet bits 2-4 in IOBs
  37     2006.03.13  [megacz]  Added constant zeroes in IOB section
  38
  39 Background
  40
  41   The Atmel AT40k Datasheet describes in great detail the resources
  42   available in the AT40k as well as the FPGA portion of the AT94k
  43   (which is functionally identical and uses the same binary
  44   configuration format).
  45
  46   The configuration space used to control these resources consists of
  47   a collection of independent octets arranged in a sparse 24-bit
  48   address space.  This document correlates those bits with the
  49   resources described in the Datasheet.
  50
  51   The process of configuring the device consists of writing these
  52   octets into the configuration memory.  Once the desired
  53   configuration octets are known, the procedures for loading them into
  54   configuration memory are well documented in Atmel Documents 1009 and
  55   2313.
  56
  57   Each data octet "D" has a 24-bit address, divided into three address
  58   octets "X", "Y", and "Z".  In general, the X and Y address octets
  59   are related to the physical position of the resource, while the Z
  60   octet is related to the type of resource being addressed.
  61
  62 Notation
  63
  64   We will use the notation A->B to indicate that setting the
  65   corresponding configuration bit high causes source A to drive wire
  66   B, and the notation A<>B to indicate that a pass gate between A and
  67   B is enabled.  The notation ~A or ~A->B indicates a configuration
  68   bit controlling A or causing A to drive B is *active low*
  69   (inverted).
  70
  71   We will use the following terms to describe routing resources.
  72   They vary slightly from Atmel's documentation, but are less
  73   ambiguous.
  74
  75    X, Y, W, Z   The cell's inputs
  76    XO, YO       The X and Y outputs from the cell (to its neighbors)
  77    N, S, E, W   Orthogonal lines: connections to neighboring cells
  78    NE,SE,NW,SW  Diagonal lines: connections to neighboring cells
  79    S0..S4       Quad lines: four-cell long routing lines
  80      H0..H4       Horizontal quad lines
  81      V0..V4       Vertical quad lines
  82    L0..L4       Switchbox ports: the wires joining FB,H0..H4,V0..V4,X,Y,Z,W
  83    G0a..G4b     Global lines: eight-cell long routing lines, in two sets (a+b)
  84    FB           The cell's internal feedback line
  85    R            The cell's internal register
  86    C            The cell's "center" output; can drive the X or Y outputs
  87    ZM           The "Z-mux"; the mux which drives the cell's register input
  88    WM           The "W-mux"; the mux which drives the third input to the LUTs
  89    XL, YL       The output of the X,Y-LUTs
  90    IA           The "internal and" gate (W & Z)
  91
  92
  93 Cartesian Resources
  94
  95   Although the exact interpretation of the X and Y octets depends on
  96   the resource type (Z octet), in most cases the X and Y octets are
  97   the cartesian coordinates of the logic cell nearest to the desired
  98   resource (0,0 is the lower-left hand logic cell).  This section
  99   describes the significance of the Z and D octets for such resources.
 100
 101   Notes:
 102     - The most significant four bits of the Z octet are 0000 for these bits
 103     - If WZ->WM and FB->WM are both low, then W->WM.
 104     - If ZM->R and YL->R are both low, then the XL->R
 105     - The ZM->C and ZM->FB bits are used to bypass the register (when high).
 106     - ~SET bit controls the set/reset behavior of the register; 0=set, 1=reset
 107
 108   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 109   |Z3:0|                           D  octet                                    |
 110   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 111   |0000| V4->L4 | H4->L4 | FB->L2 | FB->L3 | FB->L0 | FB->L1 | FB->L4 |   1    |
 112   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 113   |0001| ZM->R  | YL->R  | WZ->WM | FB->WM | ZM->C  | ZM->FB |  C->XO |  C->YO |
 114   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 115   |0010| L4->Z  | L4->Y  | L3->Z  | L2->Z  | L1->Z  | L0->Z  | V4->OE | H4->OE |
 116   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 117   |0011| L2->W  | L3->W  | L4->W  | L4->X  | L0->W  | L1->W  |H2a<>V2a|H3b<>V3b|
 118   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 119   |0100|  N->Y  |  S->Y  |  W->Y  |  E->Y  | L3->Y  | L2->Y  | L1->Y  | L0->Y  |
 120   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 121   |0101| SW->X  | NE->X  | SE->X  | NW->X  | L3->X  | L2->X  | L1->X  | L0->X  |
 122   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 123   |0110|                  X-LUT truth table, inverted                          |
 124   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 125   |0111|                  Y-LUT truth table, inverted                          |
 126   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 127   |1000| V3->L3 | H3->L3 | H2->L2 | V2->L2 | V1->L1 | H0->L0 | V0->L0 | H1->L1 |
 128   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 129   |1001|H1a<>V1a|H0a<>V0a|H0b<>V0b|H4a<>V4a|H4b<>V4b|H1b<>V1b|H3a<>V3a|H2b<>V2b|
 130   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 131   ...
 132   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 133   |0001|   1    |   1    |   1    |   1    |  ~SET  |   1    |   1    |   1    |
 134   +----+--------+--------+--------+--------+--------+--------+--------+--------+
 135
 136
 137 Sector Resources
 138
 139   Clocking, reset, and inter-sector repeaters are resources which are
 140   not specific to a particular cell.  As such, their X,Y addressing is
 141   slightly different.  These resources are addressed by the cartesian
 142   coordinates of the cell above or to the right of the resource, with
 143   an additional twist: for resources in vertical channels, the
 144   X-coordinate is shifted right by two bits (divided by four); for
 145   resources in horizontal channels, the Y-coordinate is shifted right
 146   by two bits (divided by four).
 147
 148   The most significant three bits of the Z-octet for a sector resource
 149   are set to 001; the next bit (fourth most significant) is set to 0
 150   for horizontal channels and 1 for vertical channels.
 151
 152   One sector wire and one global wire enter each side of each
 153   repeater, for a total of four connections.  Each connection has an
 154   associated four-bit code which indicates if that connection is
 155   driven by the repeater, and if so, which connection to the repeater
 156   is used to drive it:
 157
 158      000 - driver disabled
 159      100 - source is global wire on the other side of the repeater
 160      010 - source is sector wire on the other side of the repeater
 161      001 - source is other connection on the same side of the repeater
 162
 163   Example: a code of 001 for the left-hand side sector wire driver
 164   means that the source of the driver should be the left hand side
 165   global wire.  A code of 010 for the top sector wire driver means that
 166   the source of the driver should be the bottom sector wire.
 167
 168      CC     = column clock
 169      CR     = column reset
 170      SC     = sector clock
 171      CC+    = sector clock of the sector below this one
 172      InvSC  = invert the clock source (CC or S4) before driving SC
 173
 174   +----------+--------+--------+-----+-----+------+-----+-----+------+
 175   | Z octet  |                    D  octet                           |
 176   +----------+--------+--------+-----+-----+------+-----+-----+------+
 177   | 001_0000 |   1    |   0    | Left/Top      G4 | Left/Top      S4 |
 178   +----------+--------+--------+-----+-----+------+-----+-----+------+
 179   | 001_0001 |   0    | S4->CR | Right/Bottom  G4 | Right/Bottom  S4 |
 180   +----------+--------+--------+-----+-----+------+-----+-----+------+
 181   | 001_0010 |   1    |   0    | Left/Top      G3 | Left/Top      S3 |
 182   +----------+--------+--------+-----+-----+------+-----+-----+------+
 183   | 001_0011 |   1    |   1    | Right/Bottom  G3 | Right/Bottom  S3 |
 184   +----------+--------+--------+-----+-----+------+-----+-----+------+
 185   | 001_0100 |   1    |   0    | Left/Top      G2 | Left/Top      S2 |
 186   +----------+--------+--------+-----+-----+------+-----+-----+------+
 187   | 001_0101 | SC->CC+| S3->SC | Right/Bottom  G2 | Right/Bottom  S2 |
 188   +----------+--------+--------+-----+-----+------+-----+-----+------+
 189   | 001_0110 |   1    |   0    | Left/Top      G1 | Left/Top      S1 |
 190   +----------+--------+--------+-----+-----+------+-----+-----+------+
 191   | 001_0111 |   1    |   1    | Right/Bottom  G1 | Right/Bottom  S1 |
 192   +----------+--------+--------+-----+-----+------+-----+-----+------+
 193   | 001_1000 |   1    |   0    | Left/Top      G0 | Left/Top      S0 |
 194   +----------+--------+--------+-----+-----+------+-----+-----+------+
 195   | 001_1001 | InvSC  |~SC->CC+| Right/Bottom  G0 | Right/Bottom  S0 |
 196   +----------+--------+--------+----+--------+----+-----+--------+---+
 197
 198
 199 Block Memories
 200
 201   Although block memories are shown in the lower right hand corner of
 202   each sector in the Atmel Datasheets, they are conceptually addressed
 203   by the cartesian coordinate of the cell in the lower *left* hand
 204   corner of the sector.  Furthermore, both coordinates are shifted
 205   right two bits (divided by four).
 206
 207   The significance of the "D" octet for a given block memory depends
 208   on its position; if it falls in an odd sector-column (4-7, 12-15,
 209   etc), use the first chart; otherwise, use the second chart.
 210
 211     USECLK = the memory is synchronous
 212     ENABLE = the memory is enabled
 213       DUAL = enable both ports on a dual-ported memory
 214
 215   Odd Sector-Columns
 216
 217   +--------+------+------+------+------+--------+--------+--------+---------+
 218   |Z octet |                       D octet                                  |
 219   +--------+------+------+------+------+--------+---------+--------+--------+
 220   |01000000|  1   |  1   |  1   |  1   |   1    |    1    |   1    |   1    |
 221   +--------+------+------+------+------+--------+---------+--------+--------+
 222   |01000001|  1   |  1   |  1   |  1   | USECLK | ~ENABLE | ENABLE | ENABLE |
 223   +--------+------+------+------+------+--------+---------+--------+--------+
 224
 225   Even Sector-Columns
 226
 227   +--------+------+------+------+------+--------+--------+--------+--------+
 228   |Z octet |                       D octet                                 |
 229   +--------+------+------+------+------+--------+--------+--------+--------+
 230   |01000000|  1   |  1   |  1   |  1   | USECLK |  DUAL  | ~DUAL  | ENABLE |
 231   +--------+------+------+------+------+--------+--------+--------+--------+
 232   |01000001|  1   |  1   |  1   |  1   |   1    |   1    |   1    |   1    |
 233   +--------+------+------+------+------+--------+--------+--------+--------+
 234
 235
 236 I/O Blocks
 237
 238   The Z octet for I/O resources always its most significant three bits
 239   set to 011.  The next bit is 1 for North/South IO Blocks and 0 for
 240   East/West IO Blocks.  The next bit is always 0, and the bit
 241   following that is set to 0 for primary (orthogonally connected)
 242   IOBs, 1 for secondary (diagonally connected) IOBs.
 243
 244       S  = Sector wires of this cell
 245       S+ = Sector wires of next cell
 246       S- = Sector wires of previous cell
 247       G  = Global wires of this cell
 248       G+ = Global wires of next cell
 249   Output = Allow output from this IOB
 250       OE = when low, output is always enabled
 251      OEM = 7 bits, one-hot encoded, chooses input to output-enable mux
 252   USEOEM = when low, ignore the output enable mux
 253    Delay = amount of delay to add; can be 0, 1, 3, or 5
 254     Slew = slew time: 11=fast, 10=med, 01=slow
 255     Pull = 00=pullup, 11=pulldown, 01=none
 256
 257   +--------+--------+--------+------+-------+-------+--------+--------+--------+
 258   |Z octet |                         D  octet                                  |
 259   +--------+--------+--------+------+-------+-------+--------+--------+--------+
 260   |011_0_00| Schmit |      Slew     |~G2->CR|   0   |       Pull      |    0   |
 261   +--------+--------+--------+------+-------+-------+--------+--------+--------+
 262   |011_0_01|REG->OUT|    0   |  OE  |              Output Mux                  |
 263   +--------+--------+--------+------+-------+-------+--------+--------+--------+
 264   |011_0010|      Added Delay (primary)     |PRI->S-| PRI->G+| PRI->G | PRI->S |
 265   +--------+--------+--------+------+-------+-------+--------+--------+--------+
 266   |011_0110|      Added Delay (secondary)   |SND->S | SND->S+|PRI->REG|SND->REG|
 267   +--------+--------+--------+------+-------+-------+--------+--------+--------+
 268   |011_0_11|  OEM   | USEOEM |                   OEM                           |
 269   +--------+--------+--------+------+-------+-------+--------+--------+--------+
 270
 271
 272 Global Clock/Reset Networks
 273
 274   To drive a column clock from one of the eight global clock/reset
 275   networks, set the corresponding bit in the desired column:
 276
 277   +--------+--------+--------+
 278   |Z octet |X octet |Y octet |
 279   +--------+--------+--------+-----+-----+-----+-----+-----+-----+-----+-----+
 280   |10100000| column |00000000| CK1 | CK2 | CK3 | CK4 | CK5 | CK6 | CK7 | CK8 |
 281   +--------+--------+--------+-----+-----+-----+-----+-----+-----+-----+-----+
 282
 283 Unknown
 284
 285   The following configuration resources are not fully understood, but
 286   the values below appear to work.
 287
 288   +--------+--------+--------+
 289   |Z octet |X octet |Y octet |
 290   +--------+--------+--------+-----+-----+-----+-----+-----+-----+-----+-----+
 291   |        |00000000|00000000|  1  |  1  |  1  |  1  |  1  |  1  | GCK  SRC  |
 292   |10100001|00010111|00000000|  1  |  1  |  1  |  1  |  1  |  1  | GCK  SRC  |
 293   |        |00101111|00000000|  1  |  1  |  1  |  1  |  1  |  1  | GCK  SRC  |
 294   +--------+--------+--------+-----+-----+-----+-----+-----+-----+-----+-----+
 295   |11010000|00000000|00000000|  1  |  1  |  0  |  0  |  0  |  0  |  0  |  0  |
 296   +--------+--------+--------+-----+-----+-----+-----+-----+-----+-----+-----+
 297   |11010011|00000000|00000000|  0  |  0  |  0  |  0  |  1  |  1  |  0  |  1  |
 298   +--------+--------+--------+-----+-----+-----+-----+-----+-----+-----+-----+
 299
 300
 301
 302
 303