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 }; 39 40 struct mmc_internal_data { 41 /* RAW programming */ 42 unsigned int lba_start; 43 unsigned int lba_size; 44 unsigned int lba_blk_size; 45 46 /* FAT/EXT */ 47 unsigned int dev; 48 unsigned int part; 49 }; 50 51 struct nand_internal_data { 52 /* RAW programming */ 53 u64 start; 54 u64 size; 55 56 unsigned int dev; 57 unsigned int part; 58 /* for nand/ubi use */ 59 unsigned int ubi; 60 }; 61 62 struct ram_internal_data { 63 void *start; 64 unsigned int size; 65 }; 66 67 static inline unsigned int get_mmc_blk_size(int dev) 68 { 69 return find_mmc_device(dev)->read_bl_len; 70 } 71 72 #define DFU_NAME_SIZE 32 73 #define DFU_CMD_BUF_SIZE 128 74 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE 75 #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */ 76 #endif 77 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE 78 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE 79 #endif 80 #ifndef DFU_DEFAULT_POLL_TIMEOUT 81 #define DFU_DEFAULT_POLL_TIMEOUT 0 82 #endif 83 #ifndef DFU_MANIFEST_POLL_TIMEOUT 84 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT 85 #endif 86 87 struct dfu_entity { 88 char name[DFU_NAME_SIZE]; 89 int alt; 90 void *dev_private; 91 int dev_num; 92 enum dfu_device_type dev_type; 93 enum dfu_layout layout; 94 95 union { 96 struct mmc_internal_data mmc; 97 struct nand_internal_data nand; 98 struct ram_internal_data ram; 99 } data; 100 101 int (*read_medium)(struct dfu_entity *dfu, 102 u64 offset, void *buf, long *len); 103 104 int (*write_medium)(struct dfu_entity *dfu, 105 u64 offset, void *buf, long *len); 106 107 int (*flush_medium)(struct dfu_entity *dfu); 108 109 struct list_head list; 110 111 /* on the fly state */ 112 u32 crc; 113 u64 offset; 114 int i_blk_seq_num; 115 u8 *i_buf; 116 u8 *i_buf_start; 117 u8 *i_buf_end; 118 long r_left; 119 long b_left; 120 121 u32 bad_skip; /* for nand use */ 122 123 unsigned int inited:1; 124 }; 125 126 int dfu_config_entities(char *s, char *interface, int num); 127 void dfu_free_entities(void); 128 void dfu_show_entities(void); 129 int dfu_get_alt_number(void); 130 const char *dfu_get_dev_type(enum dfu_device_type t); 131 const char *dfu_get_layout(enum dfu_layout l); 132 struct dfu_entity *dfu_get_entity(int alt); 133 char *dfu_extract_token(char** e, int *n); 134 void dfu_trigger_reset(void); 135 int dfu_get_alt(char *name); 136 bool dfu_reset(void); 137 int dfu_init_env_entities(char *interface, int dev); 138 unsigned char *dfu_get_buf(void); 139 unsigned char *dfu_free_buf(void); 140 unsigned long dfu_get_buf_size(void); 141 142 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 143 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 144 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 145 /* Device specific */ 146 #ifdef CONFIG_DFU_MMC 147 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s); 148 #else 149 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s) 150 { 151 puts("MMC support not available!\n"); 152 return -1; 153 } 154 #endif 155 156 #ifdef CONFIG_DFU_NAND 157 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s); 158 #else 159 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s) 160 { 161 puts("NAND support not available!\n"); 162 return -1; 163 } 164 #endif 165 166 #ifdef CONFIG_DFU_RAM 167 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s); 168 #else 169 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s) 170 { 171 puts("RAM support not available!\n"); 172 return -1; 173 } 174 #endif 175 176 #ifdef CONFIG_DFU_FUNCTION 177 int dfu_add(struct usb_configuration *c); 178 #else 179 int dfu_add(struct usb_configuration *c) 180 { 181 return 0; 182 } 183 #endif 184 #endif /* __DFU_ENTITY_H_ */ 185