srecord: output/file/vmem.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
vmem.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 2000-2003, 2006-2008, 2010 Peter Miller
4//
5// This program is free software; you can redistribute it and/or modify
6// it under the terms of the GNU Lesser General Public License as published by
7// the Free Software Foundation; either version 3 of the License, or
8// (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU Lesser General Public License for more details.
14//
15// You should have received a copy of the GNU Lesser General Public License
16// along with this program. If not, see
17// <http://www.gnu.org/licenses/>.
18//
19
20#ifndef SRECORD_OUTPUT_FILE_VMEM_H
21#define SRECORD_OUTPUT_FILE_VMEM_H
22
23#include <srecord/output/file.h>
24
25namespace srecord
26{
27
28/**
29 * The srecord::output_file_vmem class is used to write a file in
30 * Verilog VMEM format, to be loaded using the $readmemh() call.
31 */
32 class output_file_vmem:
33 public output_file
34{
35public:
36 /**
37 * The destrutcor.
38 */
39 virtual ~output_file_vmem();
40
41private:
42 /**
43 * The constructor. It is private on purpose, use the #create
44 * class method instead.
45 *
46 * @param file_name
47 * The name of the file to be written. The special name "-"
48 * indicates the standard output is to be used.
49 */
50 output_file_vmem(const std::string &file_name);
51
52public:
53 /**
54 * The create class method is used to create new dynamically
55 * allocated instances of this class.
56 *
57 * @param file_name
58 * The name of the file to be written.
59 */
60 static pointer create(const std::string &file_name);
61
62protected:
63 // See base class for documentation.
64 void write(const record &);
65
66 // See base class for documentation.
67 void line_length_set(int);
68
69 // See base class for documentation.
70 void address_length_set(int);
71
72 // See base class for documentation.
73 int preferred_block_size_get() const;
74
75 // See base class for documentation.
76 bool preferred_block_size_set(int nbytes);
77
78 // See base class for documentation.
79 void command_line(arglex_tool *cmdln);
80
81 // See base class for documentation.
82 const char *format_name() const;
83
84private:
85 /**
86 * The bytes_per_word instance variable is used to remember how
87 * many bytes go into each word of data.
88 */
89 unsigned bytes_per_word;
90
91 /**
92 * The address instance variable is used to remember where we are
93 * up to in the output.
94 */
95 unsigned long address;
96
97 /**
98 * The column instance variable is used to remember which column
99 * we are up to in the output. Used to limit the length of lines
100 * in the output.
101 */
102 int column;
103
104 /**
105 * The pref_block_size instance variable is used to remember the
106 * number of bytes in the preferred block size.
107 */
108 int pref_block_size;
109
110 /**
111 * The width_shift instance variable is used to remember the number
112 * of bits to shift addresses when emitting them. This is based
113 * on the memory width passed to the constructor.
114 */
115 unsigned width_shift;
116
117 /**
118 * The width_mask instance variable is used to remember the lower
119 * bits to the right of the addresses shift. This is most frequently
120 * used to determine the boundaries of memory-width chunks of bytes.
121 * This value is simply a pre-caluculation of ((1u << width_shift) - 1u).
122 */
123 unsigned width_mask;
124
125 /**
126 * The default constructor. Do not use.
127 */
128 output_file_vmem();
129
130 /**
131 * The copy constructor. Do not use.
132 */
133 output_file_vmem(const output_file_vmem &);
134
135 /**
136 * The assignment operator. Do not use.
137 */
138 output_file_vmem &operator=(const output_file_vmem &);
139};
140
141};
142
143#endif // SRECORD_OUTPUT_FILE_VMEM_H
srecord::arglex_tool
The srecord::arglex_tool is used to parse command line with srec-specific arguments.
Definition tool.h:41
srecord::output_file_vmem::create
static pointer create(const std::string &file_name)
The create class method is used to create new dynamically allocated instances of this class.
srecord::output_file_vmem::~output_file_vmem
virtual ~output_file_vmem()
The destrutcor.
srecord::output_file_vmem::format_name
const char * format_name() const
The format_name method is used to obtain the name of this output format.
srecord::output_file_vmem::address_length_set
void address_length_set(int)
The address_length_set method is used to set the minimum number of bytes to be written for addresses ...
srecord::output_file_vmem::write
void write(const record &)
The write method is used to write a recordonto an output.
srecord::output_file_vmem::line_length_set
void line_length_set(int)
The set_line_length method is used to set the maximum length of an output line, for those formats for...
srecord::output_file_vmem::command_line
void command_line(arglex_tool *cmdln)
The command_line method is used by arglex_srec::get_output when parsing the command line,...
srecord::output_file_vmem::preferred_block_size_get
int preferred_block_size_get() const
The preferred_block_size_get method is used to get the proferred block size of the output fformat.
srecord::output_file_vmem::preferred_block_size_set
bool preferred_block_size_set(int nbytes)
The preferred_block_size_set method is is to set a precific number of bytes for the preferred block s...
srecord::output_file::output_file
output_file()
The default constructor.
srecord::output::pointer
std::shared_ptr< output > pointer
Definition output.h:41
srecord::record
The srecord::record class is used to represent a data record read from a file.
Definition record.h:35
srecord
Definition adler16.h:25
file.h