HAL  v4.5.0-83-g30c8f0afc
The Hardware Analyzer - a comprehensive reverse engineering and manipulation framework for gate-level netlists.
saleae_writer.h
Go to the documentation of this file.
1 // MIT License
2 //
3 // Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
4 // Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
5 // Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
6 // Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in all
16 // copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 // SOFTWARE.
25 
26 #pragma once
27 #include <filesystem>
28 #include <string>
29 #include <vector>
30 #include <unordered_map>
32 
33 namespace hal
34 {
35  class SaleaeOutputFile;
36 
42  {
43  std::filesystem::path mDir;
44  SaleaeDirectory mSaleaeDirectory;
45  std::unordered_map<int,SaleaeOutputFile*> mDataFiles;
46  public:
51  SaleaeWriter(const std::string& filename);
52 
54  ~SaleaeWriter();
55 
57  SaleaeOutputFile* add_or_replace_waveform(const std::string& name, uint32_t id);
58 
60  void add_directory_entry(int inx, const std::string& name, uint32_t id);
61  };
62 }
The SaleaeDirectory class provides the API for the SALEAE directory file. The SALEAE directory file w...
The SaleaeWriter class is a helper class which provides utility methods when importing data to SALEAE...
Definition: saleae_writer.h:42
SaleaeWriter(const std::string &filename)
void add_directory_entry(int inx, const std::string &name, uint32_t id)
Adds directory entry for net/waveform with binary file index inx.
~SaleaeWriter()
Destructor closes all open binary files updating their file header. It also updates SALEAE directory.
SaleaeOutputFile * add_or_replace_waveform(const std::string &name, uint32_t id)
Create new empty output file. Will delete existing binary file if directory links already a data file...
Definition: defines.h:45
std::string name