Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 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 | * |
Wolfgang Denk | 1a45966 | 2013-07-08 09:37:19 +0200 | [diff] [blame] | 8 | * SPDX-License-Identifier: GPL-2.0+ |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 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> |
Lukasz Majewski | a6921ad | 2013-09-17 15:58:23 +0200 | [diff] [blame] | 17 | #include <linux/usb/composite.h> |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 18 | |
| 19 | enum dfu_device_type { |
| 20 | DFU_DEV_MMC = 1, |
| 21 | DFU_DEV_ONENAND, |
| 22 | DFU_DEV_NAND, |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 23 | DFU_DEV_RAM, |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 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, |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 32 | DFU_RAM_ADDR, |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 33 | }; |
| 34 | |
Afzal Mohammed | 5a127c8 | 2013-09-18 01:14:50 +0530 | [diff] [blame] | 35 | enum dfu_op { |
| 36 | DFU_OP_READ = 1, |
| 37 | DFU_OP_WRITE, |
| 38 | }; |
| 39 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 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 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 51 | struct nand_internal_data { |
| 52 | /* RAW programming */ |
| 53 | u64 start; |
| 54 | u64 size; |
| 55 | |
| 56 | unsigned int dev; |
| 57 | unsigned int part; |
Heiko Schocher | 815c30b | 2013-07-25 06:43:11 +0200 | [diff] [blame] | 58 | /* for nand/ubi use */ |
| 59 | unsigned int ubi; |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 60 | }; |
| 61 | |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 62 | struct ram_internal_data { |
| 63 | void *start; |
| 64 | unsigned int size; |
| 65 | }; |
| 66 | |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 67 | static inline unsigned int get_mmc_blk_size(int dev) |
| 68 | { |
| 69 | return find_mmc_device(dev)->read_bl_len; |
| 70 | } |
| 71 | |
Tom Rini | a24c315 | 2013-03-14 05:32:49 +0000 | [diff] [blame] | 72 | #define DFU_NAME_SIZE 32 |
| 73 | #define DFU_CMD_BUF_SIZE 128 |
Heiko Schocher | e7e75c7 | 2013-06-12 06:05:51 +0200 | [diff] [blame] | 74 | #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE |
| 75 | #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */ |
| 76 | #endif |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 77 | #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE |
Lukasz Majewski | 7a813d5 | 2013-09-10 15:29:23 +0200 | [diff] [blame] | 78 | #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 79 | #endif |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 80 | |
| 81 | struct dfu_entity { |
| 82 | char name[DFU_NAME_SIZE]; |
| 83 | int alt; |
| 84 | void *dev_private; |
| 85 | int dev_num; |
| 86 | enum dfu_device_type dev_type; |
| 87 | enum dfu_layout layout; |
| 88 | |
| 89 | union { |
| 90 | struct mmc_internal_data mmc; |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 91 | struct nand_internal_data nand; |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 92 | struct ram_internal_data ram; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 93 | } data; |
| 94 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 95 | int (*read_medium)(struct dfu_entity *dfu, |
| 96 | u64 offset, void *buf, long *len); |
| 97 | |
| 98 | int (*write_medium)(struct dfu_entity *dfu, |
| 99 | u64 offset, void *buf, long *len); |
| 100 | |
| 101 | int (*flush_medium)(struct dfu_entity *dfu); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 102 | |
| 103 | struct list_head list; |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 104 | |
| 105 | /* on the fly state */ |
| 106 | u32 crc; |
| 107 | u64 offset; |
| 108 | int i_blk_seq_num; |
| 109 | u8 *i_buf; |
| 110 | u8 *i_buf_start; |
| 111 | u8 *i_buf_end; |
| 112 | long r_left; |
| 113 | long b_left; |
| 114 | |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 115 | u32 bad_skip; /* for nand use */ |
| 116 | |
Pantelis Antoniou | ea2453d | 2013-03-14 05:32:48 +0000 | [diff] [blame] | 117 | unsigned int inited:1; |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 118 | }; |
| 119 | |
| 120 | int dfu_config_entities(char *s, char *interface, int num); |
| 121 | void dfu_free_entities(void); |
| 122 | void dfu_show_entities(void); |
| 123 | int dfu_get_alt_number(void); |
| 124 | const char *dfu_get_dev_type(enum dfu_device_type t); |
| 125 | const char *dfu_get_layout(enum dfu_layout l); |
| 126 | struct dfu_entity *dfu_get_entity(int alt); |
| 127 | char *dfu_extract_token(char** e, int *n); |
Lukasz Majewski | 6bed7ce | 2013-07-18 13:19:14 +0200 | [diff] [blame] | 128 | void dfu_trigger_reset(void); |
Lukasz Majewski | fed936e | 2013-10-08 14:30:38 +0200 | [diff] [blame^] | 129 | int dfu_get_alt(char *name); |
Lukasz Majewski | 6bed7ce | 2013-07-18 13:19:14 +0200 | [diff] [blame] | 130 | bool dfu_reset(void); |
Lukasz Majewski | 765c5ae | 2013-09-11 14:53:35 +0200 | [diff] [blame] | 131 | int dfu_init_env_entities(char *interface, int dev); |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 132 | |
| 133 | int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
| 134 | int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); |
| 135 | /* Device specific */ |
| 136 | #ifdef CONFIG_DFU_MMC |
| 137 | extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s); |
| 138 | #else |
| 139 | static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s) |
| 140 | { |
| 141 | puts("MMC support not available!\n"); |
| 142 | return -1; |
| 143 | } |
| 144 | #endif |
Pantelis Antoniou | c663176 | 2013-03-14 05:32:52 +0000 | [diff] [blame] | 145 | |
| 146 | #ifdef CONFIG_DFU_NAND |
| 147 | extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s); |
| 148 | #else |
| 149 | static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s) |
| 150 | { |
| 151 | puts("NAND support not available!\n"); |
| 152 | return -1; |
| 153 | } |
| 154 | #endif |
| 155 | |
Afzal Mohammed | a9479f0 | 2013-09-18 01:15:24 +0530 | [diff] [blame] | 156 | #ifdef CONFIG_DFU_RAM |
| 157 | extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s); |
| 158 | #else |
| 159 | static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s) |
| 160 | { |
| 161 | puts("RAM support not available!\n"); |
| 162 | return -1; |
| 163 | } |
| 164 | #endif |
| 165 | |
Lukasz Majewski | a6921ad | 2013-09-17 15:58:23 +0200 | [diff] [blame] | 166 | #ifdef CONFIG_DFU_FUNCTION |
| 167 | int dfu_add(struct usb_configuration *c); |
| 168 | #else |
| 169 | int dfu_add(struct usb_configuration *c) |
| 170 | { |
| 171 | return 0; |
| 172 | } |
| 173 | #endif |
Lukasz Majewski | f22b11c | 2012-08-06 14:41:07 +0200 | [diff] [blame] | 174 | #endif /* __DFU_ENTITY_H_ */ |