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
|
/*
* This file defines functionality for reading and validating an FX3 firmware
* image, and providing access to the image contents.
*
* This file is part of the bladeRF project:
* http://www.github.com/nuand/bladeRF
*
* Copyright (C) 2014 Nuand LLC
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef DRIVER_FX3_FW_H_
#define DRIVER_FX3_FW_H_
#include "host_config.h"
#include <stdbool.h>
#include <stdint.h>
#include "board/board.h"
struct fx3_firmware;
/**
* Parse the contents of an FX3 firmware file into a fx3_firmware structure.
*
* @param[out] fw Handle to FX3 firmware data
* @param[in] buf Buffer containing a FX3 firmware image
* @param[in] buf_len Length of buffer
*
* @return 0 on success, BLADERF_ERR_INVAL if image validation fails,
* BLADERF_ERR_* values on other errors.
*/
int fx3_fw_parse(struct fx3_firmware **fw, uint8_t *buf, size_t buf_len);
/**
* Free the data stored in the provided fx3_firmware structure.
*
* @param[inout] fw Structure to deallocate
*/
void fx3_fw_free(struct fx3_firmware *fw);
/**
* This function allows each section to be iterated over by calling it
* repeatedly, until it returns false.
*
* @param[in] fw Handle FX3 firmware data
* @param[out] section_addr Target RAM address of the section (on the FX3)
* @param[out] section_data Updated to point to start of next section's data
* @parma[out] section_len Length of the next section
*
* @return true if this function returned section data, false if the end of the
* FW has been reached and no data is available.
*/
bool fx3_fw_next_section(struct fx3_firmware *fw,
uint32_t *section_addr,
uint8_t **section_data,
uint32_t *section_len);
/**
* @param[in] fw Handle FX3 firmware data
*
* @return The 32-bit little-endian address of the firmware entry point.
*/
uint32_t fx3_fw_entry_point(const struct fx3_firmware *fw);
#endif
|
