1 /* 2 * dfu.h - DFU flashable area description 3 * 4 * Copyright (C) 2012 Samsung Electronics 5 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com> 6 * Lukasz Majewski <l.majewski@samsung.com> 7 * 8 * SPDX-License-Identifier: GPL-2.0+ 9 */ 10 11 #ifndef __DFU_ENTITY_H_ 12 #define __DFU_ENTITY_H_ 13 14 #include <common.h> 15 #include <linux/list.h> 16 #include <mmc.h> 17 #include <linux/usb/composite.h> 18 19 enum dfu_device_type { 20 DFU_DEV_MMC = 1, 21 DFU_DEV_ONENAND, 22 DFU_DEV_NAND, 23 DFU_DEV_RAM, 24 }; 25 26 enum dfu_layout { 27 DFU_RAW_ADDR = 1, 28 DFU_FS_FAT, 29 DFU_FS_EXT2, 30 DFU_FS_EXT3, 31 DFU_FS_EXT4, 32 DFU_RAM_ADDR, 33 }; 34 35 enum dfu_op { 36 DFU_OP_READ = 1, 37 DFU_OP_WRITE, 38 DFU_OP_SIZE, 39 }; 40 41 struct mmc_internal_data { 42 /* RAW programming */ 43 unsigned int lba_start; 44 unsigned int lba_size; 45 unsigned int lba_blk_size; 46 47 /* eMMC HW partition access */ 48 int hw_partition; 49 50 /* FAT/EXT */ 51 unsigned int dev; 52 unsigned int part; 53 }; 54 55 struct nand_internal_data { 56 /* RAW programming */ 57 u64 start; 58 u64 size; 59 60 unsigned int dev; 61 unsigned int part; 62 /* for nand/ubi use */ 63 unsigned int ubi; 64 }; 65 66 struct ram_internal_data { 67 void *start; 68 unsigned int size; 69 }; 70 71 #define DFU_NAME_SIZE 32 72 #define DFU_CMD_BUF_SIZE 128 73 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE 74 #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */ 75 #endif 76 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE 77 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE 78 #endif 79 #ifndef DFU_DEFAULT_POLL_TIMEOUT 80 #define DFU_DEFAULT_POLL_TIMEOUT 0 81 #endif 82 #ifndef DFU_MANIFEST_POLL_TIMEOUT 83 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT 84 #endif 85 86 struct dfu_entity { 87 char name[DFU_NAME_SIZE]; 88 int alt; 89 void *dev_private; 90 int dev_num; 91 enum dfu_device_type dev_type; 92 enum dfu_layout layout; 93 94 union { 95 struct mmc_internal_data mmc; 96 struct nand_internal_data nand; 97 struct ram_internal_data ram; 98 } data; 99 100 long (*get_medium_size)(struct dfu_entity *dfu); 101 102 int (*read_medium)(struct dfu_entity *dfu, 103 u64 offset, void *buf, long *len); 104 105 int (*write_medium)(struct dfu_entity *dfu, 106 u64 offset, void *buf, long *len); 107 108 int (*flush_medium)(struct dfu_entity *dfu); 109 unsigned int (*poll_timeout)(struct dfu_entity *dfu); 110 111 struct list_head list; 112 113 /* on the fly state */ 114 u32 crc; 115 u64 offset; 116 int i_blk_seq_num; 117 u8 *i_buf; 118 u8 *i_buf_start; 119 u8 *i_buf_end; 120 long r_left; 121 long b_left; 122 123 u32 bad_skip; /* for nand use */ 124 125 unsigned int inited:1; 126 }; 127 128 int dfu_config_entities(char *s, char *interface, int num); 129 void dfu_free_entities(void); 130 void dfu_show_entities(void); 131 int dfu_get_alt_number(void); 132 const char *dfu_get_dev_type(enum dfu_device_type t); 133 const char *dfu_get_layout(enum dfu_layout l); 134 struct dfu_entity *dfu_get_entity(int alt); 135 char *dfu_extract_token(char** e, int *n); 136 void dfu_trigger_reset(void); 137 int dfu_get_alt(char *name); 138 bool dfu_reset(void); 139 int dfu_init_env_entities(char *interface, int dev); 140 unsigned char *dfu_get_buf(void); 141 unsigned char *dfu_free_buf(void); 142 unsigned long dfu_get_buf_size(void); 143 144 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 145 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 146 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 147 /* Device specific */ 148 #ifdef CONFIG_DFU_MMC 149 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s); 150 #else 151 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s) 152 { 153 puts("MMC support not available!\n"); 154 return -1; 155 } 156 #endif 157 158 #ifdef CONFIG_DFU_NAND 159 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s); 160 #else 161 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s) 162 { 163 puts("NAND support not available!\n"); 164 return -1; 165 } 166 #endif 167 168 #ifdef CONFIG_DFU_RAM 169 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s); 170 #else 171 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s) 172 { 173 puts("RAM support not available!\n"); 174 return -1; 175 } 176 #endif 177 178 int dfu_add(struct usb_configuration *c); 179 #endif /* __DFU_ENTITY_H_ */ 180