summaryrefslogtreecommitdiff
path: root/nvbctlib.h
blob: 279fc0fd4f3e35e4ca563b5702e1aa3736a10ea8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/**
 * Copyright (c) 2011 NVIDIA Corporation.  All rights reserved.
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

/*
 * nvbctlib is a library for accessing data in BCTs from different versions
 * of the BootROM.  This provides a means for one utility program to
 * reference data which is stored differently by different versions of chips,
 * often with the same header file names.
 *
 * In essence, nvbctlib.h defines an API for selecting chip versions and
 * accessing BCT data, and a separate source file wraps the API implementation
 * around the header files that are unique to a chip version.
 */

#ifndef INCLUDED_NVBCTLIB_H
#define INCLUDED_NVBCTLIB_H

#include <sys/types.h>
/*
 * nvbct_lib_id defines tokens used for querying or setting values within, or
 * about, the BCT.  These are used to identify values within structures,
 * sizes and other properties of structures, and values for enumerated
 * constants.
 */
typedef enum {
	nvbct_lib_id_none = 0,

	nvbct_lib_id_crypto_hash,
	nvbct_lib_id_random_aes_blk,
	nvbct_lib_id_boot_data_version,
	nvbct_lib_id_block_size_log2,
	nvbct_lib_id_page_size_log2,
	nvbct_lib_id_partition_size,
	nvbct_lib_id_dev_type,
	nvbct_lib_id_bootloader_used,
	nvbct_lib_id_bootloaders_max,
	nvbct_lib_id_reserved,
	nvbct_lib_id_reserved_size,
	nvbct_lib_id_reserved_offset,
	nvbct_lib_id_bct_size,
	nvbct_lib_id_hash_size,
	nvbct_lib_id_crypto_offset,
	nvbct_lib_id_crypto_length,
	nvbct_lib_id_max_bct_search_blks,
	nvbct_lib_id_num_param_sets,
	nvbct_lib_id_dev_type_sdmmc,
	nvbct_lib_id_dev_type_spi,

	nvbct_lib_id_sdmmc_clock_divider,
	nvbct_lib_id_sdmmc_data_width,
	nvbct_lib_id_sdmmc_max_power_class_supported,
	nvbct_lib_id_spiflash_read_command_type_fast,
	nvbct_lib_id_spiflash_clock_source,
	nvbct_lib_id_spiflash_clock_divider,
	nvbct_lib_id_sdmmc_data_width_4bit,
	nvbct_lib_id_sdmmc_data_width_8bit,
	nvbct_lib_id_spi_clock_source_pllp_out0,
	nvbct_lib_id_spi_clock_source_pllc_out0,
	nvbct_lib_id_spi_clock_source_pllm_out0,
	nvbct_lib_id_spi_clock_source_clockm,

	nvbct_lib_id_bl_version,
	nvbct_lib_id_bl_start_blk,
	nvbct_lib_id_bl_start_page,
	nvbct_lib_id_bl_length,
	nvbct_lib_id_bl_load_addr,
	nvbct_lib_id_bl_entry_point,
	nvbct_lib_id_bl_attribute,
	nvbct_lib_id_bl_crypto_hash,

	nvbct_lib_id_max,

	nvbct_lib_id_force32 = 0x7fffffff

} nvbct_lib_id;

typedef int  (*nvbct_lib_get_dev_param)(u_int32_t set,
					nvbct_lib_id id,
					u_int32_t *data,
					u_int8_t *bct);
typedef int  (*nvbct_lib_set_dev_param)(u_int32_t set,
					nvbct_lib_id id,
					u_int32_t data,
					u_int8_t *bct);

typedef int (*nvbct_lib_get_bl_param)(u_int32_t set,
					nvbct_lib_id id,
					u_int32_t *data,
					u_int8_t *bct);
typedef int (*nvbct_lib_set_bl_param)(u_int32_t set,
					nvbct_lib_id id,
					u_int32_t *data,
					u_int8_t *bct);

typedef int (*nvbct_lib_get_value)(nvbct_lib_id id,
					u_int32_t *data,
					u_int8_t *bct);
typedef int (*nvbct_lib_set_value)(nvbct_lib_id id,
					u_int32_t  data,
					u_int8_t *bct);

/*
 * Note: On input, *length is the size of data.  On output, *length is the
 * actual size used.
 */
typedef int (*nvbct_lib_get_data)(nvbct_lib_id id,
					u_int8_t *data,
					u_int32_t *length,
					u_int8_t *bct);
typedef int (*nvbct_lib_set_data)(nvbct_lib_id id,
					u_int8_t *data,
					u_int32_t  length,
					u_int8_t *bct);

/*
 * Structure of function pointers used to access a specific BCT variant.
 */
typedef struct nvbct_lib_fns_rec
{
	nvbct_lib_get_value    get_value;
	nvbct_lib_set_value    set_value;

	nvbct_lib_get_data    get_data;
	nvbct_lib_set_data    set_data;

	nvbct_lib_get_bl_param    getbl_param;
	nvbct_lib_set_bl_param    setbl_param;

	nvbct_lib_get_dev_param getdev_param;
	nvbct_lib_set_dev_param setdev_param;
} nvbct_lib_fns;

void nvbct_lib_get_fns(nvbct_lib_fns *fns);

#endif /* #ifndef INCLUDED_NVBCTLIB_H */