1 /* 2 * Copyright (c) 2024 Raspberry Pi Ltd. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef _HARDWARE_PLATFORM_DEFS_H 8 #define _HARDWARE_PLATFORM_DEFS_H 9 10 // This header is included from C and assembler - intended mostly for #defines; guard other stuff with #ifdef __ASSEMBLER__ 11 12 #ifndef _u 13 #ifdef __ASSEMBLER__ 14 #define _u(x) x 15 #else 16 #define _u(x) x ## u 17 #endif 18 #endif 19 20 #define NUM_CORES _u(2) 21 #define NUM_DMA_CHANNELS _u(12) 22 #define NUM_DMA_TIMERS _u(4) 23 #define NUM_DMA_IRQS _u(2) 24 #define NUM_IRQS _u(32) 25 #define NUM_USER_IRQS _u(6) 26 #define NUM_PIOS _u(2) 27 #define NUM_PIO_STATE_MACHINES _u(4) 28 #define NUM_PIO_IRQS _u(2) 29 #define NUM_PWM_SLICES _u(8) 30 #define NUM_PWM_IRQS _u(1) 31 #define NUM_SPIN_LOCKS _u(32) 32 #define NUM_UARTS _u(2) 33 #define NUM_I2CS _u(2) 34 #define NUM_SPIS _u(2) 35 #define NUM_GENERIC_TIMERS _u(1) 36 #define NUM_ALARMS _u(4) 37 #define ADC_BASE_PIN _u(26) 38 #define NUM_ADC_CHANNELS _u(5) 39 #define NUM_RESETS _u(24) 40 #define NUM_BANK0_GPIOS _u(30) 41 #define NUM_QSPI_GPIOS _u(6) 42 43 #define PIO_INSTRUCTION_COUNT _u(32) 44 45 #define USBCTRL_DPRAM_SIZE _u(4096) 46 47 #define HAS_SIO_DIVIDER 1 48 #define HAS_RP2040_RTC 1 49 // PICO_CONFIG: XOSC_HZ, Crystal oscillator frequency in Hz, type=int, default=12000000, advanced=true, group=hardware_base 50 // NOTE: The system and USB clocks are generated from the frequency using two PLLs. 51 // If you override this define, or SYS_CLK_HZ/USB_CLK_HZ below, you will *also* need to add your own adjusted PLL set-up defines to 52 // override the defaults which live in src/rp2_common/hardware_clocks/include/hardware/clocks.h 53 // Please see the comments there about calculating the new PLL setting values. 54 #ifndef XOSC_HZ 55 #ifdef XOSC_KHZ 56 #define XOSC_HZ ((XOSC_KHZ) * _u(1000)) 57 #elif defined(XOSC_MHZ) 58 #define XOSC_HZ ((XOSC_MHZ) * _u(1000000)) 59 #else 60 #define XOSC_HZ _u(12000000) 61 #endif 62 #endif 63 64 // PICO_CONFIG: SYS_CLK_HZ, System operating frequency in Hz, type=int, default=125000000, advanced=true, group=hardware_base 65 #ifndef SYS_CLK_HZ 66 #ifdef SYS_CLK_KHZ 67 #define SYS_CLK_HZ ((SYS_CLK_KHZ) * _u(1000)) 68 #elif defined(SYS_CLK_MHZ) 69 #define SYS_CLK_HZ ((SYS_CLK_MHZ) * _u(1000000)) 70 #else 71 #define SYS_CLK_HZ _u(125000000) 72 #endif 73 #endif 74 75 // PICO_CONFIG: USB_CLK_HZ, USB clock frequency. Must be 48MHz for the USB interface to operate correctly, type=int, default=48000000, advanced=true, group=hardware_base 76 #ifndef USB_CLK_HZ 77 #ifdef USB_CLK_KHZ 78 #define USB_CLK_HZ ((USB_CLK_KHZ) * _u(1000)) 79 #elif defined(USB_CLK_MHZ) 80 #define USB_CLK_HZ ((USB_CLK_MHZ) * _u(1000000)) 81 #else 82 #define USB_CLK_HZ _u(48000000) 83 #endif 84 #endif 85 86 // For backwards compatibility define XOSC_KHZ if the frequency is indeed an integer number of Khz. 87 #if defined(XOSC_HZ) && !defined(XOSC_KHZ) && (XOSC_HZ % 1000 == 0) 88 #define XOSC_KHZ (XOSC_HZ / 1000) 89 #endif 90 91 // For backwards compatibility define XOSC_MHZ if the frequency is indeed an integer number of Mhz. 92 #if defined(XOSC_KHZ) && !defined(XOSC_MHZ) && (XOSC_KHZ % 1000 == 0) 93 #define XOSC_MHZ (XOSC_KHZ / 1000) 94 #endif 95 96 // For backwards compatibility define SYS_CLK_KHZ if the frequency is indeed an integer number of Khz. 97 #if defined(SYS_CLK_HZ) && !defined(SYS_CLK_KHZ) && (SYS_CLK_HZ % 1000 == 0) 98 #define SYS_CLK_KHZ (SYS_CLK_HZ / 1000) 99 #endif 100 101 // For backwards compatibility define SYS_CLK_MHZ if the frequency is indeed an integer number of Mhz. 102 #if defined(SYS_CLK_KHZ) && !defined(SYS_CLK_MHZ) && (SYS_CLK_KHZ % 1000 == 0) 103 #define SYS_CLK_MHZ (SYS_CLK_KHZ / 1000) 104 #endif 105 106 // For backwards compatibility define USB_CLK_KHZ if the frequency is indeed an integer number of Khz. 107 #if defined(USB_CLK_HZ) && !defined(USB_CLK_KHZ) && (USB_CLK_HZ % 1000 == 0) 108 #define USB_CLK_KHZ (USB_CLK_HZ / 1000) 109 #endif 110 111 // For backwards compatibility define USB_CLK_MHZ if the frequency is indeed an integer number of Mhz. 112 #if defined(USB_CLK_KHZ) && !defined(USB_CLK_MHZ) && (USB_CLK_KHZ % 1000 == 0) 113 #define USB_CLK_MHZ (USB_CLK_KHZ / 1000) 114 #endif 115 116 #define FIRST_USER_IRQ (NUM_IRQS - NUM_USER_IRQS) 117 #define VTABLE_FIRST_IRQ 16 118 119 #define REG_FIELD_WIDTH(f) (f ## _MSB + 1 - f ## _LSB) 120 121 #endif 122
