include/dfu.h

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