summaryrefslogtreecommitdiff
path: root/other/Kermit/doc/API_doc/html/classrwKernel.html
diff options
context:
space:
mode:
Diffstat (limited to 'other/Kermit/doc/API_doc/html/classrwKernel.html')
-rw-r--r--other/Kermit/doc/API_doc/html/classrwKernel.html301
1 files changed, 301 insertions, 0 deletions
diff --git a/other/Kermit/doc/API_doc/html/classrwKernel.html b/other/Kermit/doc/API_doc/html/classrwKernel.html
new file mode 100644
index 0000000..193536a
--- /dev/null
+++ b/other/Kermit/doc/API_doc/html/classrwKernel.html
@@ -0,0 +1,301 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>rwKernel class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5</head><body bgcolor="#ffffff">
6<!-- Generated by Doxygen 1.2.9.1 -->
7<center>
8<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
9<hr><h1>rwKernel Class Reference</h1>Wrapper around kernel memory access.
10<a href="#_details">More...</a>
11<p>
12<code>#include &lt;<a class="el" href="rwKernel_8hpp-source.html">rwKernel.hpp</a>&gt;</code>
13<p>
14<a href="classrwKernel-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
15<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
16<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classrwKernel.html#a0">rwKernel</a> ()</td></tr>
17<tr><td>&nbsp;</td><td><font size=-1><em>Create the object with a fairly standard configuration.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
18<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classrwKernel.html#a1">rwKernel</a> (int file, int offset)</td></tr>
19<tr><td>&nbsp;</td><td><font size=-1><em>Create a rwKernel object with the defined parameters.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
20<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classrwKernel.html#a2">~rwKernel</a> ()</td></tr>
21<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
22<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classrwKernel.html#a3">read</a> (unsigned char *dest, unsigned int len, unsigned int addr)</td></tr>
23<tr><td>&nbsp;</td><td><font size=-1><em>read from kernel.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
24<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classrwKernel.html#a4">write</a> (unsigned char *src, unsigned int len, unsigned int addr)</td></tr>
25<tr><td>&nbsp;</td><td><font size=-1><em>write to kernel.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
26<tr><td nowrap align=right valign=top><a name="a5" doxytag="rwKernel::read"></a>
27void&nbsp;</td><td valign=bottom><a class="el" href="classrwKernel.html#a5">read</a> (char *a, unsigned int b, unsigned int c)</td></tr>
28<tr><td>&nbsp;</td><td><font size=-1><em>Foo.</em></font><br><br></td></tr>
29<tr><td nowrap align=right valign=top><a name="a6" doxytag="rwKernel::write"></a>
30void&nbsp;</td><td valign=bottom><a class="el" href="classrwKernel.html#a6">write</a> (char *a, unsigned int b, unsigned int c)</td></tr>
31<tr><td>&nbsp;</td><td><font size=-1><em>Foo.</em></font><br><br></td></tr>
32</table>
33<hr><a name="_details"></a><h2>Detailed Description</h2>
34Wrapper around kernel memory access.
35<p>
36It lets you read from and write to the kernel without taking care of offsets or file access.
37<p>
38<hr><h2>Constructor &amp; Destructor Documentation</h2>
39<a name="a0" doxytag="rwKernel::rwKernel"></a><p>
40<table width="100%" cellpadding="2" cellspacing="0" border="0">
41 <tr>
42 <td class="md">
43 <table cellpadding="0" cellspacing="0" border="0">
44 <tr>
45 <td class="md" nowrap valign="top">
46rwKernel::rwKernel
47 </td>
48 <td class="md">(&nbsp</td>
49 <td class="mdname"> </td>
50 <td class="md">)&nbsp;</td>
51 <td class="md"> </td>
52 </tr>
53
54 </table>
55 </td>
56 </tr>
57</table>
58<table cellspacing=5 cellpadding=0 border=0>
59 <tr>
60 <td>
61 &nbsp;
62 </td>
63 <td>
64
65<p>
66Create the object with a fairly standard configuration.
67<p>
68This constructor will assume that you want to use /dev/mem and a standard offset (as used by any 2.4.x and any 2.2.x kernel not defined to use more than 1GB of ram). </td>
69 </tr>
70</table>
71<a name="a1" doxytag="rwKernel::rwKernel"></a><p>
72<table width="100%" cellpadding="2" cellspacing="0" border="0">
73 <tr>
74 <td class="md">
75 <table cellpadding="0" cellspacing="0" border="0">
76 <tr>
77 <td class="md" nowrap valign="top">
78rwKernel::rwKernel
79 </td>
80 <td class="md">(&nbsp</td>
81 <td class="md">int </td>
82 <td class="mdname"> <em>file</em>, </td>
83 </tr>
84 <tr>
85 <td></td>
86 <td></td>
87 <td class="md"> <tr>
88 <td></td>
89 <td></td>
90 <td class="md">int </td>
91 <td class="mdname"> <em>offset</em> </td>
92 </tr>
93 <tr>
94 <td></td>
95 <td class="md">)&nbsp</td>
96 <td class="md" colspan="2"> </td>
97 </tr>
98
99 </table>
100 </td>
101 </tr>
102</table>
103<table cellspacing=5 cellpadding=0 border=0>
104 <tr>
105 <td>
106 &nbsp;
107 </td>
108 <td>
109
110<p>
111Create a rwKernel object with the defined parameters.
112<p>
113<dl compact><dt>
114Parameters: <dd>
115<table border=0 cellspacing=2 cellpadding=0>
116<tr><td valign=top><em>file
117</em>&nbsp;</td><td>
118sets the file to use. This must be either PROCKCORE (to use /proc/kcore as the memory device) or DEVMEM (to use /dev/mem as the memory device). </td></tr>
119<tr><td valign=top><em>offset
120</em>&nbsp;</td><td>
121sets the offset from real memory addresses to virtual (kernel-) addresses. This is only needed if (file == DEVMEM), otherways supply IGNORE. </td></tr>
122</table>
123</dl> </td>
124 </tr>
125</table>
126<a name="a2" doxytag="rwKernel::~rwKernel"></a><p>
127<table width="100%" cellpadding="2" cellspacing="0" border="0">
128 <tr>
129 <td class="md">
130 <table cellpadding="0" cellspacing="0" border="0">
131 <tr>
132 <td class="md" nowrap valign="top">
133rwKernel::~rwKernel
134 </td>
135 <td class="md">(&nbsp</td>
136 <td class="mdname"> </td>
137 <td class="md">)&nbsp;</td>
138 <td class="md"> </td>
139 </tr>
140
141 </table>
142 </td>
143 </tr>
144</table>
145<table cellspacing=5 cellpadding=0 border=0>
146 <tr>
147 <td>
148 &nbsp;
149 </td>
150 <td>
151
152<p>
153Destructor.
154<p>
155Will unmap the used device. </td>
156 </tr>
157</table>
158<hr><h2>Member Function Documentation</h2>
159<a name="a3" doxytag="rwKernel::read"></a><p>
160<table width="100%" cellpadding="2" cellspacing="0" border="0">
161 <tr>
162 <td class="md">
163 <table cellpadding="0" cellspacing="0" border="0">
164 <tr>
165 <td class="md" nowrap valign="top">
166void rwKernel::read
167 </td>
168 <td class="md">(&nbsp</td>
169 <td class="md">unsigned char * </td>
170 <td class="mdname"> <em>dest</em>, </td>
171 </tr>
172 <tr>
173 <td></td>
174 <td></td>
175 <td class="md"> <tr>
176 <td></td>
177 <td></td>
178 <td class="md">unsigned int </td>
179 <td class="mdname"> <em>len</em>, </td>
180 </tr>
181 <tr>
182 <td></td>
183 <td></td>
184 <td class="md"> <tr>
185 <td></td>
186 <td></td>
187 <td class="md">unsigned int </td>
188 <td class="mdname"> <em>addr</em> </td>
189 </tr>
190 <tr>
191 <td></td>
192 <td class="md">)&nbsp</td>
193 <td class="md" colspan="2"> </td>
194 </tr>
195
196 </table>
197 </td>
198 </tr>
199</table>
200<table cellspacing=5 cellpadding=0 border=0>
201 <tr>
202 <td>
203 &nbsp;
204 </td>
205 <td>
206
207<p>
208read from kernel.
209<p>
210<dl compact><dt>
211Parameters: <dd>
212<table border=0 cellspacing=2 cellpadding=0>
213<tr><td valign=top><em>dest
214</em>&nbsp;</td><td>
215read data to this address. </td></tr>
216<tr><td valign=top><em>len
217</em>&nbsp;</td><td>
218amount of bytes to read. </td></tr>
219<tr><td valign=top><em>addr
220</em>&nbsp;</td><td>
221read data from this address. </td></tr>
222</table>
223</dl> </td>
224 </tr>
225</table>
226<a name="a4" doxytag="rwKernel::write"></a><p>
227<table width="100%" cellpadding="2" cellspacing="0" border="0">
228 <tr>
229 <td class="md">
230 <table cellpadding="0" cellspacing="0" border="0">
231 <tr>
232 <td class="md" nowrap valign="top">
233void rwKernel::write
234 </td>
235 <td class="md">(&nbsp</td>
236 <td class="md">unsigned char * </td>
237 <td class="mdname"> <em>src</em>, </td>
238 </tr>
239 <tr>
240 <td></td>
241 <td></td>
242 <td class="md"> <tr>
243 <td></td>
244 <td></td>
245 <td class="md">unsigned int </td>
246 <td class="mdname"> <em>len</em>, </td>
247 </tr>
248 <tr>
249 <td></td>
250 <td></td>
251 <td class="md"> <tr>
252 <td></td>
253 <td></td>
254 <td class="md">unsigned int </td>
255 <td class="mdname"> <em>addr</em> </td>
256 </tr>
257 <tr>
258 <td></td>
259 <td class="md">)&nbsp</td>
260 <td class="md" colspan="2"> </td>
261 </tr>
262
263 </table>
264 </td>
265 </tr>
266</table>
267<table cellspacing=5 cellpadding=0 border=0>
268 <tr>
269 <td>
270 &nbsp;
271 </td>
272 <td>
273
274<p>
275write to kernel.
276<p>
277<dl compact><dt>
278Parameters: <dd>
279<table border=0 cellspacing=2 cellpadding=0>
280<tr><td valign=top><em>src
281</em>&nbsp;</td><td>
282read data from this address. </td></tr>
283<tr><td valign=top><em>len
284</em>&nbsp;</td><td>
285amount of bytes to write. </td></tr>
286<tr><td valign=top><em>addr
287</em>&nbsp;</td><td>
288write data to this address. </td></tr>
289</table>
290</dl> </td>
291 </tr>
292</table>
293<hr>The documentation for this class was generated from the following file:<ul>
294<li><a class="el" href="rwKernel_8hpp-source.html">rwKernel.hpp</a></ul>
295<hr><address><small>Generated at Tue Aug 14 18:04:51 2001 for Kermit by
296<a href="http://www.doxygen.org/index.html">
297<img src="doxygen.gif" alt="doxygen" align="middle" border=0
298width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
299 &copy;&nbsp;1997-2001</small></address>
300</body>
301</html>