📄 cml__firmware_8h-source.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Copley Motion Library: CML_Firmware.h Source File</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.4.4 --><div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div><div class="nav"><a class="el" href="dir_000001.html">inc</a></div><h1>CML_Firmware.h</h1><a href="CML__Firmware_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************/</span><a name="l00002"></a>00002 <span class="comment">/* */</span><a name="l00003"></a>00003 <span class="comment">/* Copley Motion Libraries */</span><a name="l00004"></a>00004 <span class="comment">/* */</span><a name="l00005"></a>00005 <span class="comment">/* Author: Stephen Glow */</span><a name="l00006"></a>00006 <span class="comment">/* */</span><a name="l00007"></a>00007 <span class="comment">/* Copyright (c) 2002-2005 Copley Controls Corp. */</span><a name="l00008"></a>00008 <span class="comment">/* http://www.copleycontrols.com */</span><a name="l00009"></a>00009 <span class="comment">/* */</span><a name="l00010"></a>00010 <span class="comment">/************************************************************/</span><a name="l00011"></a>00011 <span class="comment"></span><a name="l00012"></a>00012 <span class="comment">/** \file</span><a name="l00013"></a>00013 <span class="comment"></span><a name="l00014"></a>00014 <span class="comment">This file defines classes related to the Copley amplifier</span><a name="l00015"></a>00015 <span class="comment">Firmware object. The firmware object is used to update the</span><a name="l00016"></a>00016 <span class="comment">program within the amplifier. An object of this type must</span><a name="l00017"></a>00017 <span class="comment">be passed to the Amp::FirmwareUpdate method to perform this task.</span><a name="l00018"></a>00018 <span class="comment"></span><a name="l00019"></a>00019 <span class="comment">Note that firmware updates are likely to be rare, and are not</span><a name="l00020"></a>00020 <span class="comment">part of normal operation.</span><a name="l00021"></a>00021 <span class="comment"></span><a name="l00022"></a>00022 <span class="comment">*/</span><a name="l00023"></a>00023 <a name="l00024"></a>00024 <span class="preprocessor">#ifndef _DEF_INC_FIRMWARE</span><a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#define _DEF_INC_FIRMWARE</span><a name="l00026"></a>00026 <span class="preprocessor"></span><a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="CML__Settings_8h.html">CML_Settings.h</a>"</span><a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="CML__Error_8h.html">CML_Error.h</a>"</span><a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="CML__Utils_8h.html">CML_Utils.h</a>"</span><a name="l00030"></a>00030 <a name="l00031"></a>00031 <a class="code" href="CML__Settings_8h.html#a11">CML_NAMESPACE_START</a>()<a name="l00032"></a>00032 <a name="l00033"></a>00033 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00034"></a>00034 <span class="comment">/**</span><a name="l00035"></a>00035 <span class="comment">This class represents error conditions that can occur while accessing</span><a name="l00036"></a>00036 <span class="comment">a Copley Controls amplifier firmware object.</span><a name="l00037"></a>00037 <span class="comment">*/</span><a name="l00038"></a>00038 <span class="comment">/***************************************************************************/</span><a name="l00039"></a><a class="code" href="classFirmwareError.html">00039</a> class <a class="code" href="classFirmwareError.html">FirmwareError</a>: public <a class="code" href="classError.html">Error</a><a name="l00040"></a>00040 {<a name="l00041"></a>00041 <span class="keyword">public</span>:<span class="comment"></span><a name="l00042"></a>00042 <span class="comment"> /// Unable to open specified firmware file</span><a name="l00043"></a><a class="code" href="classFirmwareError.html#s0">00043</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classFirmwareError.html">FirmwareError</a> open;<a name="l00044"></a>00044 <span class="comment"></span><a name="l00045"></a>00045 <span class="comment"> /// Error reading from firmware file</span><a name="l00046"></a><a class="code" href="classFirmwareError.html#s1">00046</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classFirmwareError.html">FirmwareError</a> read;<a name="l00047"></a>00047 <span class="comment"></span><a name="l00048"></a>00048 <span class="comment"> /// File format error</span><a name="l00049"></a><a class="code" href="classFirmwareError.html#s2">00049</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classFirmwareError.html">FirmwareError</a> format;<a name="l00050"></a>00050 <span class="comment"></span><a name="l00051"></a>00051 <span class="comment"> /// File CRC error</span><a name="l00052"></a><a class="code" href="classFirmwareError.html#s3">00052</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classFirmwareError.html">FirmwareError</a> crc;<a name="l00053"></a>00053 <span class="comment"></span><a name="l00054"></a>00054 <span class="comment"> /// Memory allocation error </span><a name="l00055"></a><a class="code" href="classFirmwareError.html#s4">00055</a> <span class="comment"></span> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="classFirmwareError.html">FirmwareError</a> alloc;<a name="l00056"></a>00056 <a name="l00057"></a>00057 <span class="keyword">protected</span>:<span class="comment"></span><a name="l00058"></a>00058 <span class="comment"> /// Standard protected constructor</span><a name="l00059"></a><a class="code" href="classFirmwareError.html#b0">00059</a> <span class="comment"></span> <a class="code" href="classFirmwareError.html">FirmwareError</a>( <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <span class="keywordtype">id</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *desc ): Error( id, desc ){}<a name="l00060"></a>00060 };<a name="l00061"></a>00061 <a name="l00062"></a>00062 <span class="comment">/***************************************************************************/</span><span class="comment"></span><a name="l00063"></a>00063 <span class="comment">/**</span><a name="l00064"></a>00064 <span class="comment">Copley Controls amplifier firmware object. This object is used to represent</span><a name="l00065"></a>00065 <span class="comment">a firmware file which can be uploaded to an amplifier.</span><a name="l00066"></a>00066 <span class="comment"></span><a name="l00067"></a>00067 <span class="comment">Note that uploading firmware to the amplifier is not part of normal operation.</span><a name="l00068"></a>00068 <span class="comment">The amplifier firmware is stored in internal Flash memory, and only needs to </span><a name="l00069"></a>00069 <span class="comment">be updated if a new version with new features or bug fixes is produced by</span><a name="l00070"></a>00070 <span class="comment">Copley Controls Corporation.</span><a name="l00071"></a>00071 <span class="comment">*/</span><a name="l00072"></a>00072 <span class="comment">/***************************************************************************/</span><a name="l00073"></a><a class="code" href="classFirmware.html">00073</a> <span class="keyword">class </span><a class="code" href="classFirmware.html">Firmware</a><a name="l00074"></a>00074 {<a name="l00075"></a>00075 <span class="keyword">private</span>:<span class="comment"></span><a name="l00076"></a>00076 <span class="comment"> /// Starting address of the firmware</span><a name="l00077"></a>00077 <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> start;<a name="l00078"></a>00078 <span class="comment"></span><a name="l00079"></a>00079 <span class="comment"> /// Length of the firmware data (words)</span><a name="l00080"></a>00080 <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> length;<a name="l00081"></a>00081 <span class="comment"></span><a name="l00082"></a>00082 <span class="comment"> /// Firmware file version number</span><a name="l00083"></a>00083 <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a8">uint16</a> fileVersion;<a name="l00084"></a>00084 <span class="comment"></span><a name="l00085"></a>00085 <span class="comment"> /// Amplifier type code for firmware.</span><a name="l00086"></a>00086 <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a8">uint16</a> ampType;<a name="l00087"></a>00087 <span class="comment"></span><a name="l00088"></a>00088 <span class="comment"> /// Points to an array of 16-bit binary data.</span><a name="l00089"></a>00089 <span class="comment"> /// This is the firmware which needs to be downloaded.</span><a name="l00090"></a>00090 <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a8">uint16</a> *data;<a name="l00091"></a>00091 <a name="l00092"></a>00092 <span class="keyword">public</span>:<a name="l00093"></a>00093 <span class="keyword">virtual</span> ~<a class="code" href="classFirmware.html">Firmware</a>( <span class="keywordtype">void</span> );<a name="l00094"></a>00094 <span class="keyword">const</span> <a class="code" href="classError.html">Error</a> *Load( <span class="keyword">const</span> <span class="keywordtype">char</span> *name );<a name="l00095"></a>00095 <span class="comment"></span><a name="l00096"></a>00096 <span class="comment"> /// Returns the firmware file version number</span><a name="l00097"></a>00097 <span class="comment"> /// @return The firmware file version number</span><a name="l00098"></a><a class="code" href="classFirmware.html#a2">00098</a> <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="classFirmware.html#a2">getFileVersion</a>(){ <span class="keywordflow">return</span> fileVersion; }<a name="l00099"></a>00099 <span class="comment"></span><a name="l00100"></a>00100 <span class="comment"> /// Returns the amplifier type for this firmware</span><a name="l00101"></a>00101 <span class="comment"> /// @return The amplifier type for this firmware</span><a name="l00102"></a><a class="code" href="classFirmware.html#a3">00102</a> <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a8">uint16</a> <a class="code" href="classFirmware.html#a3">getAmpType</a>(){ <span class="keywordflow">return</span> ampType; }<a name="l00103"></a>00103 <span class="comment"></span><a name="l00104"></a>00104 <span class="comment"> /// Returns the firmware starting address</span><a name="l00105"></a>00105 <span class="comment"> /// @return The firmware starting address</span><a name="l00106"></a><a class="code" href="classFirmware.html#a4">00106</a> <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> <a class="code" href="classFirmware.html#a4">getStart</a>(){ <span class="keywordflow">return</span> start; }<a name="l00107"></a>00107 <span class="comment"></span><a name="l00108"></a>00108 <span class="comment"> /// Returns the firmware length (in words)</span><a name="l00109"></a>00109 <span class="comment"> /// @return The firmware length (in words)</span><a name="l00110"></a><a class="code" href="classFirmware.html#a5">00110</a> <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a10">uint32</a> <a class="code" href="classFirmware.html#a5">getLength</a>(){ <span class="keywordflow">return</span> length; }<a name="l00111"></a>00111 <span class="comment"></span><a name="l00112"></a>00112 <span class="comment"> /// Returns the firmware binary data</span><a name="l00113"></a>00113 <span class="comment"> /// @return The firmware binary data</span><a name="l00114"></a><a class="code" href="classFirmware.html#a6">00114</a> <span class="comment"></span> <a class="code" href="CML__Utils_8h.html#a8">uint16</a> *<a class="code" href="classFirmware.html#a6">getData</a>( <span class="keywordtype">void</span> ){ <span class="keywordflow">return</span> data; }<a name="l00115"></a>00115 <span class="comment"></span><a name="l00116"></a>00116 <span class="comment"> /// This virtual function is called repeatedly during an</span><a name="l00117"></a>00117 <span class="comment"> /// amplifier firmware update. It can be overloaded to </span><a name="l00118"></a>00118 <span class="comment"> /// display the progress of the download. This version</span><a name="l00119"></a>00119 <span class="comment"> /// does nothing.</span><a name="l00120"></a>00120 <span class="comment"> /// @param addr The address currently being downloaded.</span><a name="l00121"></a><a class="code" href="classFirmware.html#a7">00121</a> <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFirmware.html#a7">progress</a>( <a class="code" href="CML__Utils_8h.html#a10">uint32</a> addr ){}<a name="l00122"></a>00122 };<a name="l00123"></a>00123 <a name="l00124"></a>00124 <a class="code" href="CML__Settings_8h.html#a12">CML_NAMESPACE_END</a>()<a name="l00125"></a>00125 <a name="l00126"></a>00126 #endif<a name="l00127"></a>00127 </pre></div><hr><address style="align: right;"><small>Copley Motion Library, Copyright (c) 2002-2003<a href="http://www.copleycontrols.com"><img src="CCC_logo.gif" alt="Copley Controls Corp." align="middle" border=0 ></a></small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -