doc/clocks.md

   1 ## Slow clock
   2
   3 ~32kHz internal RC clock
   4
   5 Can be between 22 and 42 kHz
   6
   7 ## Main Oscillator / MAINCK
   8
   9 cf `PMC_MOR` register
  10
  11 16 MHz, based on external Xtal
  12
  13 ## PLL clock
  14
  15 cf `PMC_PLLR` register
  16
  17 96 MHz (MAINCK * 12 / 2)
  18
  19 ## Master Clock MCK, Processor Clock PCK, USB clock UDPCK
  20
  21 cf `common_arm/clocks.c`
  22
  23 cf `PMC_MCKR` and `PMC_SCER` registers
  24
  25 * MCK starts with RC slow clock (22 to 42 kHz).
  26 * Then MCK configured from PLL: 48 MHz (PLL / 2)
  27
  28 cf `bootrom.c`:
  29
  30 PCK can be disabled to enter idle mode, but on Proxmark3 it's always on, so PCK is also 48 MHz.
  31
  32 USB need to be clocked at 48 MHz from the PLL, so PLL / 2 (cf `CKGR_PLLR`).
  33
  34
  35 ## Peripheral clocks
  36
  37 cf `bootrom.c`:
  38
  39 Distribute MCK/PCK? clock to Parallel I/O controller, ADC, SPI, Synchronous Serial controller, PWM controller, USB.
  40
  41 cf `appmain.c`
  42
  43 Activate PCK0 pin as clock output, based on PLL / 4 = 24 MHz, for the FPGA.
  44
  45 ## 1 kHz RTC: TickCount functions
  46
  47 cf `armsrc/ticks.c`
  48
  49 cf `PMC_MCFR` and `RTTC_RTMR` registers for configuration, `RTTC_RTVR` register for reading value.
  50
  51 Characteristics:
  52
  53 * 1 kHz, 32b (49 days), if used with 16b: 65s
  54 * Configured at boot (or TIA) with `StartTickCount()`
  55 * Time events with `GetTickCount()`/`GetTickCountDeltaDelta()`, see example
  56 * Coarse, based on the ~32kHz RC slow clock with some adjustment factor computed by TIA
  57 * Maybe 2.5% error, can increase if temperature conditions change and no TIA is recomputed
  58 * If TimingIntervalAcquisition() is called later, StartTickCount() is called again and RTC is reset
  59
  60 Usage:
  61
  62 ```
  63 uint32_t ti = GetTickCount();
  64 ...do stuff...
  65 uint32_t delta = GetTickCountDelta(ti);
  66 ```
  67
  68 Current usages:
  69
  70 * cheap random for nonces, e.g. `prng_successor(GetTickCount(), 32)`
  71 * rough timing of some operations, only for informative purposes
  72 * timeouts
  73 * USB connection speed measure
  74
  75 ## Occasional PWM timer
  76
  77 * `void SpinDelayUs(int us)`
  78 * `void SpinDelay(int ms)` based on SpinDelayUs
  79 * `void SpinDelayUsPrecision(int us)`
  80
  81 Busy wait based on 46.875 kHz PWM Channel 0
  82
  83 * 21.3 us precision and maximum 1.39 s
  84 * *Precision* variant: 0.7 us precision and maximum 43 ms
  85
  86 ## Occasional TC0+TC1 / CountUS functions
  87
  88 cf `armsrc/ticks.c`
  89
  90 About 1 us precision
  91
  92 * `void StartCountUS(void)`
  93 * `uint32_t RAMFUNC GetCountUS(void)`
  94
  95 Use two chained timers TC0 and TC1.
  96 TC0 runs at 1.5 MHz and TC1 is clocked when TC0 reaches 0xC000.
  97
  98 Maximal value: 0x7fffffff = 2147 s
  99
 100 Can't be used at the same time as CountSspClk or Ticks functions.
 101
 102 ## Occasional TC0+TC1+TC2 SSP_CLK from FPGA / CountSspClk functions
 103
 104 cf `armsrc/ticks.c`
 105
 106 About 1 cycle of 13.56 MHz? precision
 107
 108 * `void StartCountSspClk(void)`
 109 * `void ResetSspClk(void)`
 110 * `uint32_t RAMFUNC GetCountSspClk(void)`
 111 * `uint32_t RAMFUNC GetCountSspClkDelta(uint32_t start)` <= **TODO** could be used more often
 112
 113 Use two chained timers TC0 and TC1.
 114 TC0 runs at SSP_CLK from FPGA (13.56 MHz?) and TC1 is clocked when TC0 loops.
 115
 116 Usage:
 117
 118 * for iso14443 commands to count field cycles
 119 * Also usable with FPGA in LF mode ?? cf `armsrc/legicrfsim.c` SSP Clock is clocked by the FPGA at 212 kHz (sub-carrier frequency)
 120
 121 Can't be used at the same time as CountUS or Ticks functions.
 122
 123 ## Occasional TC0+TC1 / Ticks functions
 124
 125 cf `armsrc/ticks.c`
 126
 127 1.5 MHz
 128
 129 * `void StartTicks(void)`
 130 * `uint32_t GetTicks(void)` <= **TODO** why no GetTicksDelta ?
 131 * `void WaitTicks(uint32_t ticks)`
 132 * `void WaitUS(uint32_t us)`
 133 * `void WaitMS(uint32_t ms)`
 134 * `void StopTicks(void)` <= **TODO** why a stop for this timer and not for CountUS / CountSspClk ?
 135
 136 Use two chained timers TC0 and TC1.
 137 TC0 runs at 1.5 MHz and TC1 is clocked when TC0 loops.
 138
 139 Maximal value: 0xffffffff = 2863 s (but don't use high value with WaitTicks else you'll trigger WDT)
 140
 141 Usage:
 142
 143 * Timer for bitbanging, or LF stuff when you need a very precise timer
 144
 145 Can't be used at the same time as CountUS or CountSspClk functions.