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