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
|
/* Copyright 2018 The ChromiumOS Authors
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*
* Cros Board Info
*/
#ifndef __CROS_EC_CROS_BOARD_INFO_H
#define __CROS_EC_CROS_BOARD_INFO_H
#include "common.h"
#include "ec_commands.h"
#define CBI_VERSION_MAJOR 0
#define CBI_VERSION_MINOR 0
#define CBI_EEPROM_SIZE 256
static const uint8_t cbi_magic[] = { 0x43, 0x42, 0x49 }; /* 'C' 'B' 'I' */
struct cbi_header {
uint8_t magic[3];
/* CRC of 'struct board_info' excluding magic and crc */
uint8_t crc;
/* Data format version. Parsers are expected to process data as long
* as major version is equal or younger. */
union {
struct {
uint8_t minor_version;
uint8_t major_version;
};
uint16_t version;
};
/* Total size of data. It can be larger than sizeof(struct board_info)
* if future versions add additional fields. */
uint16_t total_size;
/* List of data items (i.e. struct cbi_data[]) */
uint8_t data[];
} __attribute__((packed));
struct cbi_data {
uint8_t tag; /* enum cbi_data_tag */
uint8_t size; /* size of value[] */
uint8_t value[]; /* data value */
} __attribute__((packed));
/**
* Board info accessors
*
* @param version/sku_id/oem_id [OUT] Data read from EEPROM
* @return EC_SUCCESS on success or EC_ERROR_* otherwise.
* EC_ERROR_BUSY to indicate data is not ready.
*/
int cbi_get_board_version(uint32_t *version);
int cbi_get_sku_id(uint32_t *sku_id);
int cbi_get_oem_id(uint32_t *oem_id);
int cbi_get_model_id(uint32_t *id);
/**
* Get data from CBI store
*
* @param tag Tag of the target data.
* @param buf Buffer where data is passed.
* @param size (IN) Size of <buf>. (OUT) Size of the data returned.
* @return EC_SUCCESS on success or EC_ERROR_* otherwise.
* EC_ERROR_BUSY to indicate data is not ready.
*/
int cbi_get_board_info(enum cbi_data_tag tag, uint8_t *buf, uint8_t *size);
/**
* Set data in CBI store
*
* @param tag Tag of the target data.
* @param buf Buffer where data is passed.
* @param size (IN) Size of <buf>. (OUT) Size of the data returned.
* @return EC_SUCCESS on success or EC_ERROR_* otherwise.
*/
int cbi_set_board_info(enum cbi_data_tag tag, const uint8_t *buf, uint8_t size);
/*
* Utility functions
*/
/**
* Calculate 8-bit CRC of CBI
*
* @param h Pointer to CBI header
* @return CRC value
*/
uint8_t cbi_crc8(const struct cbi_header *h);
/**
* Store data in memory in CBI data format
*
* @param p Pointer to the buffer where a new data item will be stored. It
* should be pointing to the data section of CBI.
* @param tag Tag of the data item
* @param buf Pointer to the buffer containing the data being copied.
* @param size Size of the data in bytes. Must be 0 < size < 256.
* @return Address of the byte following the stored data in the
* destination buffer
*/
uint8_t *cbi_set_data(uint8_t *p, enum cbi_data_tag tag,
const void *buf, int size);
/**
* Store string data in memory in CBI data format.
*
* @param p Pointer to the buffer where a new data item will be stored. It
* should be pointing to the data section of CBI.
* @param tag Tag of the data item
* @param str Pointer to the string data being copied. If pointer is NULL,
* this function will ignore adding the tag as well. Else, the
* string data will be added to CBI using size of strlen + 1. This
* string is assumed to be NUL-terminated and NUL gets stored in
* CBI along with the string data.
* @return Address of the byte following the stored data in the destination
* buffer.
*/
uint8_t *cbi_set_string(uint8_t *p, enum cbi_data_tag tag, const char *str);
/**
* Find a data field in CBI
*
* @param cbi Buffer containing CBI struct
* @param tag Tag of the data field to search
* @return Pointer to the data or NULL if not found.
*/
struct cbi_data *cbi_find_tag(const void *cbi, enum cbi_data_tag tag);
/**
* Callback implemented by board to manipulate data
*
* Note that this is part of the APIs (cbi_get_*) which can be called in any
* order any time. Your callback should return EC_SUCCESS only after it has all
* the data needed for manipulation. Until then, it should return EC_ERROR_BUSY.
* That'll provide a consistent view to the callers, which is critical for CBI
* to be functional.
*
* @param tag Tag of the data field to be manipulated
* @param buf Pointer to the buffer containing the data being manipulated.
* @param size size of the date in bytes
* @return EC_SUCCESS to indicate the data is ready.
* EC_ERROR_BUSY to indicate supplemental data is not ready.
*/
int cbi_board_override(enum cbi_data_tag tag, uint8_t *buf, uint8_t *size);
#endif /* __CROS_EC_CROS_BOARD_INFO_H */
|
