Tanya Brokhman | 1c94f1a | 2015-02-15 09:05:03 +0200 | [diff] [blame] | 1 | /* Copyright (c) 2014-2015, The Linux Foundation. All rights reserved. |
| 2 | * |
| 3 | * Redistribution and use in source and binary forms, with or without |
| 4 | * modification, are permitted provided that the following conditions are |
| 5 | * met: |
| 6 | * * Redistributions of source code must retain the above copyright |
| 7 | * notice, this list of conditions and the following disclaimer. |
| 8 | * * Redistributions in binary form must reproduce the above |
| 9 | * copyright notice, this list of conditions and the following |
| 10 | * disclaimer in the documentation and/or other materials provided |
| 11 | * with the distribution. |
| 12 | * * Neither the name of The Linux Foundation nor the names of its |
| 13 | * contributors may be used to endorse or promote products derived |
| 14 | * from this software without specific prior written permission. |
| 15 | * |
| 16 | * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED |
| 17 | * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| 18 | * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT |
| 19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS |
| 20 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR |
| 23 | * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| 24 | * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE |
| 25 | * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN |
| 26 | * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 27 | */ |
| 28 | |
| 29 | #ifndef _FLASH_UBI_H_ |
| 30 | #define _FLASH_UBI_H_ |
| 31 | |
| 32 | #include <sys/types.h> |
| 33 | #include <lib/ptable.h> |
| 34 | #include <stdint.h> |
| 35 | |
| 36 | /* Erase counter header magic number (ASCII "UBI#") */ |
| 37 | #define UBI_EC_HDR_MAGIC 0x55424923 |
| 38 | |
| 39 | #define UBI_MAGIC "UBI#" |
| 40 | #define UBI_MAGIC_SIZE 0x04 |
| 41 | |
Tanya Brokhman | ea981a3 | 2015-02-12 16:32:15 +0200 | [diff] [blame] | 42 | #define UBI_VERSION 1 |
| 43 | #define UBI_MAX_ERASECOUNTER 0x7FFFFFFF |
| 44 | #define UBI_IMAGE_SEQ_BASE 0x12345678 |
| 45 | #define UBI_DEF_ERACE_COUNTER 0 |
| 46 | #define UBI_CRC32_INIT 0xFFFFFFFFU |
| 47 | |
| 48 | /* Erase counter header fields */ |
| 49 | struct __attribute__ ((packed)) ubi_ec_hdr { |
| 50 | uint32_t magic; |
| 51 | uint8_t version; |
| 52 | uint8_t padding1[3]; |
| 53 | uint64_t ec; /* Warning: the current limit is 31-bit anyway! */ |
| 54 | uint32_t vid_hdr_offset; |
| 55 | uint32_t data_offset; |
| 56 | uint32_t image_seq; |
| 57 | uint8_t padding2[32]; |
| 58 | uint32_t hdr_crc; |
| 59 | }; |
| 60 | |
Tanya Brokhman | c52aeb8 | 2015-01-27 11:08:50 +0200 | [diff] [blame^] | 61 | /* Volume identifier header fields */ |
| 62 | struct __attribute__ ((packed)) ubi_vid_hdr { |
| 63 | uint32_t magic; |
| 64 | uint8_t version; |
| 65 | uint8_t vol_type; |
| 66 | uint8_t copy_flag; |
| 67 | uint8_t compat; |
| 68 | uint32_t vol_id; |
| 69 | uint32_t lnum; |
| 70 | uint8_t padding1[4]; |
| 71 | uint32_t data_size; |
| 72 | uint32_t used_ebs; |
| 73 | uint32_t data_pad; |
| 74 | uint32_t data_crc; |
| 75 | uint8_t padding2[4]; |
| 76 | uint64_t sqnum; |
| 77 | uint8_t padding3[12]; |
| 78 | uint32_t hdr_crc; |
| 79 | }; |
Tanya Brokhman | ea981a3 | 2015-02-12 16:32:15 +0200 | [diff] [blame] | 80 | |
Tanya Brokhman | c52aeb8 | 2015-01-27 11:08:50 +0200 | [diff] [blame^] | 81 | #define UBI_EC_HDR_SIZE sizeof(struct ubi_ec_hdr) |
| 82 | #define UBI_VID_HDR_SIZE sizeof(struct ubi_vid_hdr) |
| 83 | #define UBI_EC_HDR_SIZE_CRC (UBI_EC_HDR_SIZE - sizeof(uint32_t)) |
| 84 | #define UBI_VID_HDR_SIZE_CRC (UBI_VID_HDR_SIZE - sizeof(uint32_t)) |
| 85 | |
| 86 | #define UBI_FM_SB_VOLUME_ID (0x7FFFFFFF - 4096 + 1) |
Tanya Brokhman | ea981a3 | 2015-02-12 16:32:15 +0200 | [diff] [blame] | 87 | /** |
| 88 | * struct ubi_scan_info - UBI scanning information. |
| 89 | * @ec: erase counters or eraseblock status for all eraseblocks |
| 90 | * @mean_ec: mean erase counter |
| 91 | * @bad_cnt: count of bad eraseblocks |
| 92 | * @good_cnt: count of non-bad eraseblocks |
| 93 | * @empty_cnt: count of empty eraseblocks |
| 94 | * @vid_hdr_offs: volume ID header offset from the found EC headers (%-1 means |
| 95 | * undefined) |
| 96 | * @data_offs: data offset from the found EC headers (%-1 means undefined) |
| 97 | * @image_seq: image sequence |
| 98 | */ |
| 99 | struct ubi_scan_info { |
| 100 | uint64_t *ec; |
| 101 | uint64_t mean_ec; |
| 102 | int bad_cnt; |
| 103 | int good_cnt; |
| 104 | int empty_cnt; |
| 105 | unsigned vid_hdr_offs; |
| 106 | unsigned data_offs; |
| 107 | uint32_t image_seq; |
| 108 | }; |
| 109 | |
| 110 | int flash_ubi_img(struct ptentry *ptn, void *data, unsigned size); |
Tanya Brokhman | 1c94f1a | 2015-02-15 09:05:03 +0200 | [diff] [blame] | 111 | #endif |