include/proxmark3_arm.h

   1 //-----------------------------------------------------------------------------
   2 // Copyright (C) Proxmark3 contributors. See AUTHORS.md for details.
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // See LICENSE.txt for the text of the license.
  15 //-----------------------------------------------------------------------------
  16 // Hardware and interface definitions
  17 //-----------------------------------------------------------------------------
  18
  19 #ifndef __PROXMARK3_H
  20 #define __PROXMARK3_H
  21
  22 #include "common.h"
  23
  24 // Might as well have the hardware-specific defines everywhere.
  25 #include "at91sam7s512.h"
  26 #include "config_gpio.h"
  27 #include "pm3_cmd.h"
  28
  29 // Check bootrom.c for actual clock settings
  30 #define MAINCK                                  16000000
  31 #define MCK                                     (3 * MAINCK)
  32
  33 #define WDT_HIT()                               AT91C_BASE_WDTC->WDTC_WDCR = 0xa5000001
  34
  35 #define PWM_CH_MODE_PRESCALER(x)                ((x) << 0)
  36 #define PWM_CHANNEL(x)                          (1 << (x))
  37
  38 #define ADC_CHAN_LF                             4
  39 #if defined RDV4 || defined ICOPYX
  40 #define ADC_CHAN_HF                             7
  41 #else
  42 #define ADC_CHAN_HF                             5
  43 #endif
  44 #define ADC_MODE_PRESCALE(x)                    ((x) << 8)
  45 #define ADC_MODE_STARTUP_TIME(x)                ((x) << 16)
  46 #define ADC_MODE_SAMPLE_HOLD_TIME(x)            ((x) << 24)
  47 #define ADC_CHANNEL(x)                          (1 << (x))
  48 #define ADC_END_OF_CONVERSION(x)                (1 << (x))
  49
  50 #define SSC_CLOCK_MODE_START(x)                 ((x) << 8)
  51 #define SSC_FRAME_MODE_WORDS_PER_TRANSFER(x)    ((x) << 8)
  52 #define SSC_CLOCK_MODE_SELECT(x)                ((x) << 0)
  53 #define SSC_FRAME_MODE_BITS_IN_WORD(x)          (((x)-1) << 0)
  54
  55 #define MC_FLASH_COMMAND_KEY                    ((0x5A) << 24)
  56 #define MC_FLASH_MODE_FLASH_WAIT_STATES(x)      ((x) << 8)
  57 #define MC_FLASH_MODE_MASTER_CLK_IN_MHZ(x)      (((x)+((x)/2)) << 16)
  58 #define MC_FLASH_COMMAND_PAGEN(x)               ((x) << 8)
  59
  60 #define RST_CONTROL_KEY                         (0xA5U << 24)
  61
  62 #define PMC_MAIN_OSC_STARTUP_DELAY(x)           ((x) << 8)
  63 #define PMC_PLL_DIVISOR(x)                      (x)
  64 #define PMC_PLL_MULTIPLIER(x)                   (((x)-1) << 16)
  65 #define PMC_PLL_COUNT_BEFORE_LOCK(x)            (((x) & 0x3F) << 8)        // 6bit register 0011 1111
  66 #define PMC_PLL_FREQUENCY_RANGE(x)              (((x) & 0x3) << 14)        // 2bit register
  67 #define PMC_PLL_USB_DIVISOR(x)                  ((x) << 28)
  68
  69 #define UDP_INTERRUPT_ENDPOINT(x)               (1 << (x))
  70 #define UDP_CSR_BYTES_RECEIVED(x)               (((x) >> 16) & 0x7ff)
  71 //**************************************************************
  72
  73
  74
  75 #define LOW(x)      AT91C_BASE_PIOA->PIO_CODR |= (x)
  76 #define HIGH(x)     AT91C_BASE_PIOA->PIO_SODR |= (x)
  77
  78 #define GETBIT(x)   (AT91C_BASE_PIOA->PIO_ODSR & (x)) ? 1:0
  79 #define SETBIT(x, y) (y) ? (HIGH(x)):(LOW(x))
  80 #define INVBIT(x)   SETBIT((x), !(GETBIT(x)))
  81
  82 // Setup for SPI current modes
  83 #define SPI_FPGA_MODE   0
  84 #define SPI_LCD_MODE    1
  85 #define SPI_MEM_MODE    2
  86
  87 #ifndef COTAG_BITS
  88 #define COTAG_BITS 264
  89 #endif
  90
  91 #define LED_A_ON()        HIGH(GPIO_LED_A)
  92 #define LED_A_OFF()       LOW(GPIO_LED_A)
  93 #define LED_A_INV()       INVBIT(GPIO_LED_A)
  94 #define LED_B_ON()        HIGH(GPIO_LED_B)
  95 #define LED_B_OFF()       LOW(GPIO_LED_B)
  96 #define LED_B_INV()       INVBIT(GPIO_LED_B)
  97 #define LED_C_ON()        HIGH(GPIO_LED_C)
  98 #define LED_C_OFF()       LOW(GPIO_LED_C)
  99 #define LED_C_INV()       INVBIT(GPIO_LED_C)
 100 #define LED_D_ON()        HIGH(GPIO_LED_D)
 101 #define LED_D_OFF()       LOW(GPIO_LED_D)
 102 #define LED_D_INV()       INVBIT(GPIO_LED_D)
 103
 104
 105 // SPI
 106 #define SCK_LOW           LOW(GPIO_SPCK)
 107 #define SCK_HIGH          HIGH(GPIO_SPCK)
 108 #define MOSI_HIGH         HIGH(GPIO_MOSI)
 109 #define MOSI_LOW          LOW(GPIO_MOSI)
 110 #define MISO_VALUE        (AT91C_BASE_PIOA->PIO_PDSR & GPIO_MISO)
 111
 112 // fpga
 113 #define NCS_0_LOW         LOW(GPIO_NCS0)
 114 #define NCS_0_HIGH        HIGH(GPIO_NCS0)
 115
 116 // flash mem PA1
 117 #define NCS_1_LOW         LOW(GPIO_NCS2)
 118 #define NCS_1_HIGH        HIGH(GPIO_NCS2)
 119
 120 #define RELAY_ON()        HIGH(GPIO_RELAY)
 121 #define RELAY_OFF()       LOW(GPIO_RELAY)
 122
 123 #define BUTTON_PRESS()         !((AT91C_BASE_PIOA->PIO_PDSR & GPIO_BUTTON) == GPIO_BUTTON)
 124 #define WAIT_BUTTON_RELEASED() { while ( BUTTON_PRESS() )  { WDT_HIT(); }; }
 125
 126 //NVDD goes LOW when USB is attached.
 127 #define USB_ATTACHED()    !((AT91C_BASE_PIOA->PIO_PDSR & GPIO_NVDD_ON) == GPIO_NVDD_ON)
 128
 129 // VERSION_INFORMATION is now in common.h
 130
 131 #define COMMON_AREA_MAGIC 0x43334d50 // "PM3C"
 132 #define COMMON_AREA_COMMAND_NONE 0
 133 #define COMMON_AREA_COMMAND_ENTER_FLASH_MODE 1
 134 typedef struct {
 135     int magic; /* Magic sequence, to distinguish against random uninitialized memory */
 136     char version; /* Must be 1 */
 137     char command;
 138     struct {
 139         unsigned int bootrom_present: 1; /* Set when a bootrom that is capable of parsing the common area is present */
 140         unsigned int osimage_present: 1; /* Set when a osimage that is capable of parsing the common area is present */
 141         unsigned int button_pressed: 1;
 142     } PACKED flags;
 143     int arg1, arg2;
 144 } PACKED common_area_t;
 145
 146 #endif