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