]> git.zerfleddert.de Git - proxmark3-svn/blob - include/proxmark3.h
Minor dox
[proxmark3-svn] / include / proxmark3.h
1 //-----------------------------------------------------------------------------
2 // Jonathan Westhues, Mar 2006
3 //
4 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
5 // at your option, any later version. See the LICENSE.txt file for the text of
6 // the license.
7 //-----------------------------------------------------------------------------
8 // Hardware and interface definitions
9 //-----------------------------------------------------------------------------
10
11 #ifndef __PROXMARK3_H
12 #define __PROXMARK3_H
13
14 // Might as well have the hardware-specific defines everywhere.
15 #include "at91sam7s512.h"
16 #include "config_gpio.h"
17 #include "usb_cmd.h"
18
19 #define WDT_HIT() AT91C_BASE_WDTC->WDTC_WDCR = 0xa5000001
20
21 #define PWM_CH_MODE_PRESCALER(x) ((x)<<0)
22 #define PWM_CHANNEL(x) (1<<(x))
23
24 #define ADC_CHAN_LF 4
25 #define ADC_CHAN_HF 5
26 #define ADC_MODE_PRESCALE(x) ((x)<<8)
27 #define ADC_MODE_STARTUP_TIME(x) ((x)<<16)
28 #define ADC_MODE_SAMPLE_HOLD_TIME(x) ((x)<<24)
29 #define ADC_CHANNEL(x) (1<<(x))
30 #define ADC_END_OF_CONVERSION(x) (1<<(x))
31
32 #define SSC_CLOCK_MODE_START(x) ((x)<<8)
33 #define SSC_FRAME_MODE_WORDS_PER_TRANSFER(x) ((x)<<8)
34 #define SSC_CLOCK_MODE_SELECT(x) ((x)<<0)
35 #define SSC_FRAME_MODE_BITS_IN_WORD(x) (((x)-1)<<0)
36
37 #define MC_FLASH_COMMAND_KEY ((0x5a)<<24)
38 #define MC_FLASH_MODE_FLASH_WAIT_STATES(x) ((x)<<8)
39 #define MC_FLASH_MODE_MASTER_CLK_IN_MHZ(x) (((x)+((x)/2))<<16)
40 #define MC_FLASH_COMMAND_PAGEN(x) ((x)<<8)
41
42 #define RST_CONTROL_KEY (0xa5<<24)
43
44 #define PMC_MAIN_OSC_STARTUP_DELAY(x) ((x)<<8)
45 #define PMC_PLL_DIVISOR(x) (x)
46 #define PMC_PLL_MULTIPLIER(x) (((x)-1)<<16)
47 #define PMC_PLL_COUNT_BEFORE_LOCK(x) ((x)<<8)
48 #define PMC_PLL_FREQUENCY_RANGE(x) ((x)<<14)
49 #define PMC_PLL_USB_DIVISOR(x) ((x)<<28)
50
51 #define UDP_INTERRUPT_ENDPOINT(x) (1<<(x))
52 #define UDP_CSR_BYTES_RECEIVED(x) (((x) >> 16) & 0x7ff)
53 //**************************************************************
54
55 #define LOW(x) AT91C_BASE_PIOA->PIO_CODR = (x)
56 #define HIGH(x) AT91C_BASE_PIOA->PIO_SODR = (x)
57 #define GETBIT(x) (AT91C_BASE_PIOA->PIO_ODSR & (x)) ? 1:0
58 #define SETBIT(x, y) (y) ? (HIGH(x)):(LOW(x))
59 #define INVBIT(x) SETBIT((x), !(GETBIT(x)))
60
61 #define SPI_FPGA_MODE 0
62 #define SPI_LCD_MODE 1
63
64 #define FPGA_BITSTREAM_ERR 0
65 #define FPGA_BITSTREAM_LF 1
66 #define FPGA_BITSTREAM_HF 2
67
68 #define TRUE 1
69 #define FALSE 0
70
71 //#define PACKED __attribute__((__packed__))
72
73 #define LED_A_ON() HIGH(GPIO_LED_A)
74 #define LED_A_OFF() LOW(GPIO_LED_A)
75 #define LED_A_INV() INVBIT(GPIO_LED_A)
76 #define LED_B_ON() HIGH(GPIO_LED_B)
77 #define LED_B_OFF() LOW(GPIO_LED_B)
78 #define LED_B_INV() INVBIT(GPIO_LED_B)
79 #define LED_C_ON() HIGH(GPIO_LED_C)
80 #define LED_C_OFF() LOW(GPIO_LED_C)
81 #define LED_C_INV() INVBIT(GPIO_LED_C)
82 #define LED_D_ON() HIGH(GPIO_LED_D)
83 #define LED_D_OFF() LOW(GPIO_LED_D)
84 #define LED_D_INV() INVBIT(GPIO_LED_D)
85 #define RELAY_ON() HIGH(GPIO_RELAY)
86 #define RELAY_OFF() LOW(GPIO_RELAY)
87 #define BUTTON_PRESS() !(AT91C_BASE_PIOA->PIO_PDSR & GPIO_BUTTON)
88
89 #define VERSION_INFORMATION_MAGIC 0x56334d50
90 struct version_information {
91 int magic; /* Magic sequence to identify this as a correct version information structure. Must be VERSION_INFORMATION_MAGIC */
92 char versionversion; /* Must be 1 */
93 char present; /* 1 if the version information could be created at compile time, otherwise 0 and the remaining fields (except for magic) are empty */
94 char clean; /* 1: Tree was clean, no local changes. 0: Tree was unclean. 2: Couldn't be determined */
95 char gitversion[50]; /* String with the git revision */
96 char buildtime[30]; /* string with the build time */
97 } __attribute__((packed));
98
99 #define COMMON_AREA_MAGIC 0x43334d50
100 #define COMMON_AREA_COMMAND_NONE 0
101 #define COMMON_AREA_COMMAND_ENTER_FLASH_MODE 1
102 struct common_area {
103 int magic; /* Magic sequence, to distinguish against random uninitialized memory */
104 char version; /* Must be 1 */
105 char command;
106 struct {
107 unsigned int bootrom_present:1; /* Set when a bootrom that is capable of parsing the common area is present */
108 unsigned int osimage_present:1; /* Set when a osimage that is capable of parsing the common area is present */
109 } __attribute__((packed)) flags;
110 int arg1, arg2;
111 } __attribute__((packed));
112
113 #endif
Impressum, Datenschutz