xref: /rk3399_rockchip-uboot/include/dfu.h (revision c6631764c2a64efc91c84077ca65f4fee153f133)
1f22b11c1SLukasz Majewski /*
2f22b11c1SLukasz Majewski  * dfu.h - DFU flashable area description
3f22b11c1SLukasz Majewski  *
4f22b11c1SLukasz Majewski  * Copyright (C) 2012 Samsung Electronics
5f22b11c1SLukasz Majewski  * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
6f22b11c1SLukasz Majewski  *	    Lukasz Majewski <l.majewski@samsung.com>
7f22b11c1SLukasz Majewski  *
8f22b11c1SLukasz Majewski  * This program is free software; you can redistribute it and/or modify
9f22b11c1SLukasz Majewski  * it under the terms of the GNU General Public License as published by
10f22b11c1SLukasz Majewski  * the Free Software Foundation; either version 2 of the License, or
11f22b11c1SLukasz Majewski  * (at your option) any later version.
12f22b11c1SLukasz Majewski  *
13f22b11c1SLukasz Majewski  * This program is distributed in the hope that it will be useful,
14f22b11c1SLukasz Majewski  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15f22b11c1SLukasz Majewski  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16f22b11c1SLukasz Majewski  * GNU General Public License for more details.
17f22b11c1SLukasz Majewski  *
18f22b11c1SLukasz Majewski  * You should have received a copy of the GNU General Public License
19f22b11c1SLukasz Majewski  * along with this program; if not, write to the Free Software
20f22b11c1SLukasz Majewski  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21f22b11c1SLukasz Majewski  */
22f22b11c1SLukasz Majewski 
23f22b11c1SLukasz Majewski #ifndef __DFU_ENTITY_H_
24f22b11c1SLukasz Majewski #define __DFU_ENTITY_H_
25f22b11c1SLukasz Majewski 
26f22b11c1SLukasz Majewski #include <common.h>
27f22b11c1SLukasz Majewski #include <linux/list.h>
28f22b11c1SLukasz Majewski #include <mmc.h>
29f22b11c1SLukasz Majewski 
30f22b11c1SLukasz Majewski enum dfu_device_type {
31f22b11c1SLukasz Majewski 	DFU_DEV_MMC = 1,
32f22b11c1SLukasz Majewski 	DFU_DEV_ONENAND,
33f22b11c1SLukasz Majewski 	DFU_DEV_NAND,
34f22b11c1SLukasz Majewski };
35f22b11c1SLukasz Majewski 
36f22b11c1SLukasz Majewski enum dfu_layout {
37f22b11c1SLukasz Majewski 	DFU_RAW_ADDR = 1,
38f22b11c1SLukasz Majewski 	DFU_FS_FAT,
39f22b11c1SLukasz Majewski 	DFU_FS_EXT2,
40f22b11c1SLukasz Majewski 	DFU_FS_EXT3,
41f22b11c1SLukasz Majewski 	DFU_FS_EXT4,
42f22b11c1SLukasz Majewski };
43f22b11c1SLukasz Majewski 
44f22b11c1SLukasz Majewski struct mmc_internal_data {
45f22b11c1SLukasz Majewski 	/* RAW programming */
46f22b11c1SLukasz Majewski 	unsigned int lba_start;
47f22b11c1SLukasz Majewski 	unsigned int lba_size;
48f22b11c1SLukasz Majewski 	unsigned int lba_blk_size;
49f22b11c1SLukasz Majewski 
50f22b11c1SLukasz Majewski 	/* FAT/EXT */
51f22b11c1SLukasz Majewski 	unsigned int dev;
52f22b11c1SLukasz Majewski 	unsigned int part;
53f22b11c1SLukasz Majewski };
54f22b11c1SLukasz Majewski 
55*c6631764SPantelis Antoniou struct nand_internal_data {
56*c6631764SPantelis Antoniou 	/* RAW programming */
57*c6631764SPantelis Antoniou 	u64 start;
58*c6631764SPantelis Antoniou 	u64 size;
59*c6631764SPantelis Antoniou 
60*c6631764SPantelis Antoniou 	unsigned int dev;
61*c6631764SPantelis Antoniou 	unsigned int part;
62*c6631764SPantelis Antoniou };
63*c6631764SPantelis Antoniou 
64f22b11c1SLukasz Majewski static inline unsigned int get_mmc_blk_size(int dev)
65f22b11c1SLukasz Majewski {
66f22b11c1SLukasz Majewski 	return find_mmc_device(dev)->read_bl_len;
67f22b11c1SLukasz Majewski }
68f22b11c1SLukasz Majewski 
69f22b11c1SLukasz Majewski #define DFU_NAME_SIZE			32
70f22b11c1SLukasz Majewski #define DFU_CMD_BUF_SIZE		128
713cb5ca75SŁukasz Majewski #define DFU_DATA_BUF_SIZE		(1024*1024*8)	/* 8 MiB */
72ea2453d5SPantelis Antoniou #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
73ea2453d5SPantelis Antoniou #define CONFIG_SYS_DFU_MAX_FILE_SIZE	(4 << 20)	/* 4 MiB */
74ea2453d5SPantelis Antoniou #endif
75f22b11c1SLukasz Majewski 
76f22b11c1SLukasz Majewski struct dfu_entity {
77f22b11c1SLukasz Majewski 	char			name[DFU_NAME_SIZE];
78f22b11c1SLukasz Majewski 	int                     alt;
79f22b11c1SLukasz Majewski 	void                    *dev_private;
80f22b11c1SLukasz Majewski 	int                     dev_num;
81f22b11c1SLukasz Majewski 	enum dfu_device_type    dev_type;
82f22b11c1SLukasz Majewski 	enum dfu_layout         layout;
83f22b11c1SLukasz Majewski 
84f22b11c1SLukasz Majewski 	union {
85f22b11c1SLukasz Majewski 		struct mmc_internal_data mmc;
86*c6631764SPantelis Antoniou 		struct nand_internal_data nand;
87f22b11c1SLukasz Majewski 	} data;
88f22b11c1SLukasz Majewski 
89ea2453d5SPantelis Antoniou 	int (*read_medium)(struct dfu_entity *dfu,
90ea2453d5SPantelis Antoniou 			u64 offset, void *buf, long *len);
91ea2453d5SPantelis Antoniou 
92ea2453d5SPantelis Antoniou 	int (*write_medium)(struct dfu_entity *dfu,
93ea2453d5SPantelis Antoniou 			u64 offset, void *buf, long *len);
94ea2453d5SPantelis Antoniou 
95ea2453d5SPantelis Antoniou 	int (*flush_medium)(struct dfu_entity *dfu);
96f22b11c1SLukasz Majewski 
97f22b11c1SLukasz Majewski 	struct list_head list;
98ea2453d5SPantelis Antoniou 
99ea2453d5SPantelis Antoniou 	/* on the fly state */
100ea2453d5SPantelis Antoniou 	u32 crc;
101ea2453d5SPantelis Antoniou 	u64 offset;
102ea2453d5SPantelis Antoniou 	int i_blk_seq_num;
103ea2453d5SPantelis Antoniou 	u8 *i_buf;
104ea2453d5SPantelis Antoniou 	u8 *i_buf_start;
105ea2453d5SPantelis Antoniou 	u8 *i_buf_end;
106ea2453d5SPantelis Antoniou 	long r_left;
107ea2453d5SPantelis Antoniou 	long b_left;
108ea2453d5SPantelis Antoniou 
109*c6631764SPantelis Antoniou 	u32 bad_skip;	/* for nand use */
110*c6631764SPantelis Antoniou 
111ea2453d5SPantelis Antoniou 	unsigned int inited:1;
112f22b11c1SLukasz Majewski };
113f22b11c1SLukasz Majewski 
114f22b11c1SLukasz Majewski int dfu_config_entities(char *s, char *interface, int num);
115f22b11c1SLukasz Majewski void dfu_free_entities(void);
116f22b11c1SLukasz Majewski void dfu_show_entities(void);
117f22b11c1SLukasz Majewski int dfu_get_alt_number(void);
118f22b11c1SLukasz Majewski const char *dfu_get_dev_type(enum dfu_device_type t);
119f22b11c1SLukasz Majewski const char *dfu_get_layout(enum dfu_layout l);
120f22b11c1SLukasz Majewski struct dfu_entity *dfu_get_entity(int alt);
121f22b11c1SLukasz Majewski char *dfu_extract_token(char** e, int *n);
122f22b11c1SLukasz Majewski 
123f22b11c1SLukasz Majewski int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
124f22b11c1SLukasz Majewski int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
125f22b11c1SLukasz Majewski /* Device specific */
126f22b11c1SLukasz Majewski #ifdef CONFIG_DFU_MMC
127f22b11c1SLukasz Majewski extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s);
128f22b11c1SLukasz Majewski #else
129f22b11c1SLukasz Majewski static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s)
130f22b11c1SLukasz Majewski {
131f22b11c1SLukasz Majewski 	puts("MMC support not available!\n");
132f22b11c1SLukasz Majewski 	return -1;
133f22b11c1SLukasz Majewski }
134f22b11c1SLukasz Majewski #endif
135*c6631764SPantelis Antoniou 
136*c6631764SPantelis Antoniou #ifdef CONFIG_DFU_NAND
137*c6631764SPantelis Antoniou extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s);
138*c6631764SPantelis Antoniou #else
139*c6631764SPantelis Antoniou static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s)
140*c6631764SPantelis Antoniou {
141*c6631764SPantelis Antoniou 	puts("NAND support not available!\n");
142*c6631764SPantelis Antoniou 	return -1;
143*c6631764SPantelis Antoniou }
144*c6631764SPantelis Antoniou #endif
145*c6631764SPantelis Antoniou 
146f22b11c1SLukasz Majewski #endif /* __DFU_ENTITY_H_ */
147