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