1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2015, NVIDIA Corporation. 4 */ 5 6 #ifndef _FALCON_H_ 7 #define _FALCON_H_ 8 9 #include <linux/types.h> 10 11 #define FALCON_UCLASS_METHOD_OFFSET 0x00000040 12 13 #define FALCON_UCLASS_METHOD_DATA 0x00000044 14 15 #define FALCON_IRQMSET 0x00001010 16 #define FALCON_IRQMSET_WDTMR (1 << 1) 17 #define FALCON_IRQMSET_HALT (1 << 4) 18 #define FALCON_IRQMSET_EXTERR (1 << 5) 19 #define FALCON_IRQMSET_SWGEN0 (1 << 6) 20 #define FALCON_IRQMSET_SWGEN1 (1 << 7) 21 #define FALCON_IRQMSET_EXT(v) (((v) & 0xff) << 8) 22 23 #define FALCON_IRQDEST 0x0000101c 24 #define FALCON_IRQDEST_HALT (1 << 4) 25 #define FALCON_IRQDEST_EXTERR (1 << 5) 26 #define FALCON_IRQDEST_SWGEN0 (1 << 6) 27 #define FALCON_IRQDEST_SWGEN1 (1 << 7) 28 #define FALCON_IRQDEST_EXT(v) (((v) & 0xff) << 8) 29 30 #define FALCON_ITFEN 0x00001048 31 #define FALCON_ITFEN_CTXEN (1 << 0) 32 #define FALCON_ITFEN_MTHDEN (1 << 1) 33 34 #define FALCON_IDLESTATE 0x0000104c 35 36 #define FALCON_CPUCTL 0x00001100 37 #define FALCON_CPUCTL_STARTCPU (1 << 1) 38 39 #define FALCON_BOOTVEC 0x00001104 40 41 #define FALCON_DMACTL 0x0000110c 42 #define FALCON_DMACTL_DMEM_SCRUBBING (1 << 1) 43 #define FALCON_DMACTL_IMEM_SCRUBBING (1 << 2) 44 45 #define FALCON_DMATRFBASE 0x00001110 46 47 #define FALCON_DMATRFMOFFS 0x00001114 48 49 #define FALCON_DMATRFCMD 0x00001118 50 #define FALCON_DMATRFCMD_FULL (1 << 0) 51 #define FALCON_DMATRFCMD_IDLE (1 << 1) 52 #define FALCON_DMATRFCMD_IMEM (1 << 4) 53 #define FALCON_DMATRFCMD_SIZE_256B (6 << 8) 54 #define FALCON_DMATRFCMD_DMACTX(v) (((v) & 0x7) << 12) 55 56 #define FALCON_DMATRFFBOFFS 0x0000111c 57 58 #define RISCV_BOOT_VECTOR_LO 0x00001780 59 #define RISCV_BOOT_VECTOR_HI 0x00001784 60 61 #define RISCV_CPUCTL 0x00001788 62 #define RISCV_CPUCTL_STARTCPU (1 << 0) 63 #define RISCV_CPUCTL_ACTIVE_STAT_ACTIVE (1 << 7) 64 65 #define RISCV_BCR_CTRL 0x00001a68 66 #define RISCV_BCR_CTRL_CORE_SELECT_RISCV (1 << 4) 67 68 struct falcon_fw_bin_header_v1 { 69 u32 magic; /* 0x10de */ 70 u32 version; /* version of bin format (1) */ 71 u32 size; /* entire image size including this header */ 72 u32 os_header_offset; 73 u32 os_data_offset; 74 u32 os_size; 75 }; 76 77 struct falcon_fw_os_app_v1 { 78 u32 offset; 79 u32 size; 80 }; 81 82 struct falcon_fw_os_header_v1 { 83 u32 code_offset; 84 u32 code_size; 85 u32 data_offset; 86 u32 data_size; 87 }; 88 89 struct falcon_fw_riscv_desc { 90 u32 reserved[74]; 91 u32 data_offset; 92 u32 data_size; 93 u32 code_offset; 94 u32 code_size; 95 }; 96 97 struct falcon_firmware_section { 98 unsigned long offset; 99 size_t size; 100 }; 101 102 struct falcon_firmware { 103 /* Firmware after it is read but not loaded */ 104 const struct firmware *firmware; 105 /* RISC-V firmware descriptor */ 106 const struct firmware *desc_firmware; 107 108 /* Raw firmware data */ 109 dma_addr_t iova; 110 dma_addr_t phys; 111 void *virt; 112 size_t size; 113 114 /* Parsed firmware information */ 115 struct falcon_firmware_section bin_data; 116 struct falcon_firmware_section data; 117 struct falcon_firmware_section code; 118 }; 119 120 struct falcon { 121 /* Set by falcon client */ 122 struct device *dev; 123 void __iomem *regs; 124 125 /* Peregrine falcon, external boot */ 126 bool riscv; 127 128 struct falcon_firmware firmware; 129 }; 130 131 int falcon_init(struct falcon *falcon); 132 void falcon_exit(struct falcon *falcon); 133 int falcon_read_firmware(struct falcon *falcon, const char *firmware_name); 134 int falcon_load_firmware(struct falcon *falcon); 135 int falcon_boot(struct falcon *falcon); 136 void falcon_execute_method(struct falcon *falcon, u32 method, u32 data); 137 int falcon_wait_idle(struct falcon *falcon); 138 139 #endif /* _FALCON_H_ */ 140