blob: 26ffbc8e81d2d4ac82620b179a84f5077cf01b7b [file] [log] [blame]
Lukasz Majewskid311c6e2012-08-06 14:41:07 +02001/*
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 Denkd79de1d2013-07-08 09:37:19 +02008 * SPDX-License-Identifier: GPL-2.0+
Lukasz Majewskid311c6e2012-08-06 14:41:07 +02009 */
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 Majewskic4219462013-09-17 15:58:23 +020017#include <linux/usb/composite.h>
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020018
19enum dfu_device_type {
20 DFU_DEV_MMC = 1,
21 DFU_DEV_ONENAND,
22 DFU_DEV_NAND,
Afzal Mohammede3c687a2013-09-18 01:15:24 +053023 DFU_DEV_RAM,
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020024};
25
26enum dfu_layout {
27 DFU_RAW_ADDR = 1,
28 DFU_FS_FAT,
29 DFU_FS_EXT2,
30 DFU_FS_EXT3,
31 DFU_FS_EXT4,
Afzal Mohammede3c687a2013-09-18 01:15:24 +053032 DFU_RAM_ADDR,
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020033};
34
Afzal Mohammedb9a4a6b2013-09-18 01:14:50 +053035enum dfu_op {
36 DFU_OP_READ = 1,
37 DFU_OP_WRITE,
38};
39
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020040struct mmc_internal_data {
41 /* RAW programming */
42 unsigned int lba_start;
43 unsigned int lba_size;
44 unsigned int lba_blk_size;
45
Lukasz Majewski4da65ea2014-05-09 16:58:15 +020046 /* eMMC HW partition access */
47 int hw_partition;
48
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020049 /* FAT/EXT */
50 unsigned int dev;
51 unsigned int part;
52};
53
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +000054struct nand_internal_data {
55 /* RAW programming */
56 u64 start;
57 u64 size;
58
59 unsigned int dev;
60 unsigned int part;
Heiko Schocherad401392013-07-25 06:43:11 +020061 /* for nand/ubi use */
62 unsigned int ubi;
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +000063};
64
Afzal Mohammede3c687a2013-09-18 01:15:24 +053065struct ram_internal_data {
66 void *start;
67 unsigned int size;
68};
69
Tom Rini7384b5a2013-03-14 05:32:49 +000070#define DFU_NAME_SIZE 32
71#define DFU_CMD_BUF_SIZE 128
Heiko Schochera2f831e2013-06-12 06:05:51 +020072#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
73#define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
74#endif
Pantelis Antonioua6e788d2013-03-14 05:32:48 +000075#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
Lukasz Majewski3dda2202013-09-10 15:29:23 +020076#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
Pantelis Antonioua6e788d2013-03-14 05:32:48 +000077#endif
Lukasz Majewski2bb115f2013-12-09 16:20:14 +010078#ifndef DFU_DEFAULT_POLL_TIMEOUT
79#define DFU_DEFAULT_POLL_TIMEOUT 0
80#endif
Heiko Schochere1ba1512014-03-18 08:09:56 +010081#ifndef DFU_MANIFEST_POLL_TIMEOUT
82#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
83#endif
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020084
85struct dfu_entity {
86 char name[DFU_NAME_SIZE];
87 int alt;
88 void *dev_private;
89 int dev_num;
90 enum dfu_device_type dev_type;
91 enum dfu_layout layout;
92
93 union {
94 struct mmc_internal_data mmc;
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +000095 struct nand_internal_data nand;
Afzal Mohammede3c687a2013-09-18 01:15:24 +053096 struct ram_internal_data ram;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +020097 } data;
98
Pantelis Antonioua6e788d2013-03-14 05:32:48 +000099 int (*read_medium)(struct dfu_entity *dfu,
100 u64 offset, void *buf, long *len);
101
102 int (*write_medium)(struct dfu_entity *dfu,
103 u64 offset, void *buf, long *len);
104
105 int (*flush_medium)(struct dfu_entity *dfu);
Heiko Schocherb9488102014-04-11 07:59:47 +0200106 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200107
108 struct list_head list;
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000109
110 /* on the fly state */
111 u32 crc;
112 u64 offset;
113 int i_blk_seq_num;
114 u8 *i_buf;
115 u8 *i_buf_start;
116 u8 *i_buf_end;
117 long r_left;
118 long b_left;
119
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000120 u32 bad_skip; /* for nand use */
121
Pantelis Antonioua6e788d2013-03-14 05:32:48 +0000122 unsigned int inited:1;
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200123};
124
125int dfu_config_entities(char *s, char *interface, int num);
126void dfu_free_entities(void);
127void dfu_show_entities(void);
128int dfu_get_alt_number(void);
129const char *dfu_get_dev_type(enum dfu_device_type t);
130const char *dfu_get_layout(enum dfu_layout l);
131struct dfu_entity *dfu_get_entity(int alt);
132char *dfu_extract_token(char** e, int *n);
Lukasz Majewski2968aa22013-07-18 13:19:14 +0200133void dfu_trigger_reset(void);
Lukasz Majewski1737f0f2013-10-08 14:30:38 +0200134int dfu_get_alt(char *name);
Lukasz Majewski2968aa22013-07-18 13:19:14 +0200135bool dfu_reset(void);
Lukasz Majewski35e591e2013-09-11 14:53:35 +0200136int dfu_init_env_entities(char *interface, int dev);
Lukasz Majewski34264232013-10-08 14:30:39 +0200137unsigned char *dfu_get_buf(void);
138unsigned char *dfu_free_buf(void);
Lukasz Majewski031d4132013-12-09 16:20:13 +0100139unsigned long dfu_get_buf_size(void);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200140
141int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
142int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heiko Schocher941b3842014-03-18 08:09:55 +0100143int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200144/* Device specific */
145#ifdef CONFIG_DFU_MMC
146extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s);
147#else
148static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s)
149{
150 puts("MMC support not available!\n");
151 return -1;
152}
153#endif
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +0000154
155#ifdef CONFIG_DFU_NAND
156extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s);
157#else
158static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s)
159{
160 puts("NAND support not available!\n");
161 return -1;
162}
163#endif
164
Afzal Mohammede3c687a2013-09-18 01:15:24 +0530165#ifdef CONFIG_DFU_RAM
166extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s);
167#else
168static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s)
169{
170 puts("RAM support not available!\n");
171 return -1;
172}
173#endif
174
Lukasz Majewskic4219462013-09-17 15:58:23 +0200175int dfu_add(struct usb_configuration *c);
Lukasz Majewskid311c6e2012-08-06 14:41:07 +0200176#endif /* __DFU_ENTITY_H_ */