uhd/host/lib/include/uhdlib/utils/ihex.hpp
Martin Braun 6652eb4a03 uhd: Move internal headers to uhdlib/
To avoid the proliferation of additional include directories and
multiple ways of including project-local headers, we now default to
moving all headers that are used across UHD into the uhdlib/
subdirectory.

Some #include statements were also reordered as they were modified for
closer compliance with the coding guidelines.

Internal cpp source files should now include files like this:

    #include <uhdlib/rfnoc/ctrl_iface.hpp>

Reviewed-by: Ashish Chaudhari <ashish.chaudhari@ettus.com>
2018-03-14 15:17:44 -07:00

69 lines
1.9 KiB
C++

//
// Copyright 2015 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef INCLUDED_IHEX_READER_HPP
#define INCLUDED_IHEX_READER_HPP
#include <boost/bind.hpp>
#include <boost/function.hpp>
#include <stdint.h>
#include <string>
#include <vector>
namespace uhd {
class ihex_reader
{
public:
// Arguments are: lower address bits, upper address bits, buff, length
typedef boost::function<int(uint16_t,uint16_t,unsigned char*,uint16_t)> record_handle_type;
/*
* \param ihex_filename Path to the *.ihx file
*/
ihex_reader(const std::string &ihex_filename);
/*! Read an Intel HEX file and handle it record by record.
*
* Every record is individually passed off to a record handler function.
*
* \param record_handler The functor that will handle the records.
*
* \throws uhd::io_error if the HEX file is corrupted or unreadable.
*/
void read(record_handle_type record_handler);
/* Convert the ihex file to a bin file.
*
* *Note:* This function makes the assumption that the hex file is
* contiguous, and starts at address zero.
*
* \param bin_filename Output filename.
*
* \throws uhd::io_error if the HEX file is corrupted or unreadable.
*/
void to_bin_file(const std::string &bin_filename);
/*! Copy the ihex file into a buffer.
*
* Very similar functionality as to_bin_file().
*
* *Note:* This function makes the assumption that the hex file is
* contiguous, and starts at address zero.
*
* \throws uhd::io_error if the HEX file is corrupted or unreadable.
*/
std::vector<uint8_t> to_vector(const size_t size_estimate = 0);
private:
const std::string _ihex_filename;
};
}; /* namespace uhd */
#endif /* INCLUDED_IHEX_READER_HPP */