UbixOS/doc/xml/ramdrive_8h.xml at 1.0-RELEASE

Fork: 0
MrOlsen / UbixOS
Find file
Newer
Older
UbixOS / doc / xml / ramdrive_8h.xml
Christopher W. Olsen on 15 Nov 2017 14 KB Adding Sources
Raw Blame History
<?xml version='1.0' encoding='iso-8859-1' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.4.7">
  <compounddef id="ramdrive_8h" kind="file">
    <compoundname>ramdrive.h</compoundname>
    <includes refid="ubixfsv2_2device_8h" local="no">device.h</includes>
    <includedby refid="main_8cpp" local="yes">src/sys/ubixfsv2/main.cpp</includedby>
    <incdepgraph>
      <node id="4598">
        <label>sys/types.h</label>
      </node>
      <node id="4599">
        <label>types.h</label>
        <link refid="ubixfsv2_2types_8h"/>
      </node>
      <node id="4597">
        <label>device.h</label>
        <link refid="ubixfsv2_2device_8h"/>
        <childnode refid="4598" relation="include">
        </childnode>
        <childnode refid="4599" relation="include">
        </childnode>
      </node>
      <node id="4596">
        <label>src/sys/ubixfsv2/ramdrive.h</label>
        <link refid="ramdrive.h"/>
        <childnode refid="4597" relation="include">
        </childnode>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="4601">
        <label>src/sys/ubixfsv2/main.cpp</label>
        <link refid="main_8cpp"/>
      </node>
      <node id="4600">
        <label>src/sys/ubixfsv2/ramdrive.h</label>
        <link refid="ramdrive.h"/>
        <childnode refid="4601" relation="include">
        </childnode>
      </node>
    </invincdepgraph>
      <sectiondef kind="func">
      <memberdef kind="function" id="ramdrive_8h_18be6ecd0c2c51beb0c5fd98fd7980a24" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>int</type>
        <definition>int dev_ramDestroy</definition>
        <argsstring>()</argsstring>
        <name>dev_ramDestroy</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/home/reddawg/source/ubix2/src/sys/ubixfsv2/ramdrive.h" line="35" bodyfile="/usr/home/reddawg/source/ubix2/src/sys/ubixfsv2/ramdrive.cpp" bodystart="95" bodyend="108"/>
        <references refid="include_2vfs_2file_8h_1872c22366b4c63f4bdb10cd3b7980b11" compoundref="file_8c" startline="398" endline="425">fclose</references>
        <references refid="include_2vfs_2file_8h_1d6a41ac88a7d46d574e8a675fdde136c" compoundref="file_8c" startline="274" endline="389">fopen</references>
        <references refid="include_2vfs_2file_8h_1ca6c1e5b57dc9f5d8551b41ea98bfbb7" compoundref="file_8c" startline="200" endline="206">fwrite</references>
        <references refid="ramdrive_8cpp_13d93ebd0d0885d3fcff115d98e8b4aaf" compoundref="ramdrive_8cpp" startline="37">ram_data</references>
        <references refid="ramdrive_8cpp_1fa106ea6087f9f8423b6ecc98dda7741" compoundref="ramdrive_8cpp" startline="39">RAM_DRIVE_SIZE</references>
        <referencedby refid="main_8cpp_1840291bc02cba5474a4cb46a9b9566fe" compoundref="main_8cpp" startline="12" endline="65">main</referencedby>
      </memberdef>
      <memberdef kind="function" id="ramdrive_8h_10d903e082fe2e6d8f1e06073560e5ab3" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type><ref refid="structdevice__t" kindref="compound">device_t</ref> *</type>
        <definition>device_t* dev_ramDrive</definition>
        <argsstring>()</argsstring>
        <name>dev_ramDrive</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/usr/home/reddawg/source/ubix2/src/sys/ubixfsv2/ramdrive.h" line="36" bodyfile="/usr/home/reddawg/source/ubix2/src/sys/ubixfsv2/ramdrive.cpp" bodystart="66" bodyend="92"/>
        <references refid="include_2vfs_2file_8h_1872c22366b4c63f4bdb10cd3b7980b11" compoundref="file_8c" startline="398" endline="425">fclose</references>
        <references refid="include_2vfs_2file_8h_1d6a41ac88a7d46d574e8a675fdde136c" compoundref="file_8c" startline="274" endline="389">fopen</references>
        <references refid="include_2vfs_2file_8h_13b06878a03209e88c008c77234b89359" compoundref="file_8c" startline="178" endline="198">fread</references>
        <references refid="structdevice__t_1d03b23eb98c9f6f3befb7e3cdb015738" compoundref="ubixfsv2_2device_8h" startline="51">device_t::major</references>
        <references refid="ramdrive_8cpp_13d93ebd0d0885d3fcff115d98e8b4aaf" compoundref="ramdrive_8cpp" startline="37">ram_data</references>
        <references refid="ramdrive_8cpp_1fa106ea6087f9f8423b6ecc98dda7741" compoundref="ramdrive_8cpp" startline="39">RAM_DRIVE_SIZE</references>
        <references refid="ramdrive_8cpp_138167738dfd96ad366c00f66c6ad30e0" compoundref="ramdrive_8cpp" startline="43" endline="50">ramDrive_read</references>
        <references refid="ramdrive_8cpp_179604a2fffa2b0d95884fec8c65a0051" compoundref="ramdrive_8cpp" startline="54" endline="63">ramDrive_write</references>
        <references refid="structdevice__t_19d3cb5a5fdcf892fe1a9683142174f7f">device_t::read</references>
        <references refid="structdevice__t_12f31531436aa42b8c47bd26d38f5247d" compoundref="ubixfsv2_2device_8h" startline="53">device_t::sectors</references>
        <references refid="structdevice__t_13bbbd39c26ac540dbbb934faffe752fb">device_t::write</references>
        <referencedby refid="main_8cpp_1840291bc02cba5474a4cb46a9b9566fe" compoundref="main_8cpp" startline="12" endline="65">main</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <programlisting>
<codeline lineno="1"><highlight class="comment">/*****************************************************************************************</highlight></codeline>
<codeline lineno="2"><highlight class="comment"><sp/>Copyright<sp/>(c)<sp/>2002-2004<sp/>The<sp/>UbixOS<sp/>Project</highlight></codeline>
<codeline lineno="3"><highlight class="comment"><sp/>All<sp/>rights<sp/>reserved.</highlight></codeline>
<codeline lineno="4"><highlight class="comment"></highlight></codeline>
<codeline lineno="5"><highlight class="comment"><sp/>Redistribution<sp/>and<sp/>use<sp/>in<sp/>source<sp/>and<sp/>binary<sp/>forms,<sp/>with<sp/>or<sp/>without<sp/>modification,<sp/>are</highlight></codeline>
<codeline lineno="6"><highlight class="comment"><sp/>permitted<sp/>provided<sp/>that<sp/>the<sp/>following<sp/>conditions<sp/>are<sp/>met:</highlight></codeline>
<codeline lineno="7"><highlight class="comment"></highlight></codeline>
<codeline lineno="8"><highlight class="comment"><sp/>Redistributions<sp/>of<sp/>source<sp/>code<sp/>must<sp/>retain<sp/>the<sp/>above<sp/>copyright<sp/>notice,<sp/>this<sp/>list<sp/>of</highlight></codeline>
<codeline lineno="9"><highlight class="comment"><sp/>conditions,<sp/>the<sp/>following<sp/>disclaimer<sp/>and<sp/>the<sp/>list<sp/>of<sp/>authors.<sp/><sp/>Redistributions<sp/>in<sp/>binary</highlight></codeline>
<codeline lineno="10"><highlight class="comment"><sp/>form<sp/>must<sp/>reproduce<sp/>the<sp/>above<sp/>copyright<sp/>notice,<sp/>this<sp/>list<sp/>of<sp/>conditions,<sp/>the<sp/>following</highlight></codeline>
<codeline lineno="11"><highlight class="comment"><sp/>disclaimer<sp/>and<sp/>the<sp/>list<sp/>of<sp/>authors<sp/>in<sp/>the<sp/>documentation<sp/>and/or<sp/>other<sp/>materials<sp/>provided</highlight></codeline>
<codeline lineno="12"><highlight class="comment"><sp/>with<sp/>the<sp/>distribution.<sp/>Neither<sp/>the<sp/>name<sp/>of<sp/>the<sp/>UbixOS<sp/>Project<sp/>nor<sp/>the<sp/>names<sp/>of<sp/>its</highlight></codeline>
<codeline lineno="13"><highlight class="comment"><sp/>contributors<sp/>may<sp/>be<sp/>used<sp/>to<sp/>endorse<sp/>or<sp/>promote<sp/>products<sp/>derived<sp/>from<sp/>this<sp/>software</highlight></codeline>
<codeline lineno="14"><highlight class="comment"><sp/>without<sp/>specific<sp/>prior<sp/>written<sp/>permission.</highlight></codeline>
<codeline lineno="15"><highlight class="comment"></highlight></codeline>
<codeline lineno="16"><highlight class="comment"><sp/>THIS<sp/>SOFTWARE<sp/>IS<sp/>PROVIDED<sp/>BY<sp/>THE<sp/>COPYRIGHT<sp/>HOLDERS<sp/>AND<sp/>CONTRIBUTORS<sp/>&quot;AS<sp/>IS&quot;<sp/>AND<sp/>ANY</highlight></codeline>
<codeline lineno="17"><highlight class="comment"><sp/>EXPRESS<sp/>OR<sp/>IMPLIED<sp/>WARRANTIES,<sp/>INCLUDING,<sp/>BUT<sp/>NOT<sp/>LIMITED<sp/>TO,<sp/>THE<sp/>IMPLIED<sp/>WARRANTIES<sp/>OF</highlight></codeline>
<codeline lineno="18"><highlight class="comment"><sp/>MERCHANTABILITY<sp/>AND<sp/>FITNESS<sp/>FOR<sp/>A<sp/>PARTICULAR<sp/>PURPOSE<sp/>ARE<sp/>DISCLAIMED.<sp/>IN<sp/>NO<sp/>EVENT<sp/>SHALL</highlight></codeline>
<codeline lineno="19"><highlight class="comment"><sp/>THE<sp/>COPYRIGHT<sp/>OWNER<sp/>OR<sp/>CONTRIBUTORS<sp/>BE<sp/>LIABLE<sp/>FOR<sp/>ANY<sp/>DIRECT,<sp/>INDIRECT,<sp/>INCIDENTAL,</highlight></codeline>
<codeline lineno="20"><highlight class="comment"><sp/>SPECIAL,<sp/>EXEMPLARY,<sp/>OR<sp/>CONSEQUENTIAL<sp/>DAMAGES<sp/>(INCLUDING,<sp/>BUT<sp/>NOT<sp/>LIMITED<sp/>TO,<sp/>PROCUREMENT</highlight></codeline>
<codeline lineno="21"><highlight class="comment"><sp/>OF<sp/>SUBSTITUTE<sp/>GOODS<sp/>OR<sp/>SERVICES;<sp/>LOSS<sp/>OF<sp/>USE,<sp/>DATA,<sp/>OR<sp/>PROFITS;<sp/>OR<sp/>BUSINESS<sp/>INTERRUPTION)</highlight></codeline>
<codeline lineno="22"><highlight class="comment"><sp/>HOWEVER<sp/>CAUSED<sp/>AND<sp/>ON<sp/>ANY<sp/>THEORY<sp/>OF<sp/>LIABILITY,<sp/>WHETHER<sp/>IN<sp/>CONTRACT,<sp/>STRICT<sp/>LIABILITY,<sp/>OR</highlight></codeline>
<codeline lineno="23"><highlight class="comment"><sp/>TORT<sp/>(INCLUDING<sp/>NEGLIGENCE<sp/>OR<sp/>OTHERWISE)<sp/>ARISING<sp/>IN<sp/>ANY<sp/>WAY<sp/>OUT<sp/>OF<sp/>THE<sp/>USE<sp/>OF<sp/>THIS</highlight></codeline>
<codeline lineno="24"><highlight class="comment"><sp/>SOFTWARE,<sp/>EVEN<sp/>IF<sp/>ADVISED<sp/>OF<sp/>THE<sp/>POSSIBILITY<sp/>OF<sp/>SUCH<sp/>DAMAGE.</highlight></codeline>
<codeline lineno="25"><highlight class="comment"></highlight></codeline>
<codeline lineno="26"><highlight class="comment"><sp/>$Id: ramdrive_8h.xml 88 2016-01-12 00:11:29Z reddawg $</highlight></codeline>
<codeline lineno="27"><highlight class="comment"></highlight></codeline>
<codeline lineno="28"><highlight class="comment">*****************************************************************************************/</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="29"><highlight class="normal"></highlight></codeline>
<codeline lineno="30"><highlight class="normal"></highlight><highlight class="preprocessor">#ifndef<sp/>__RAMDRIVE_H_</highlight></codeline>
<codeline lineno="31"><highlight class="preprocessor"></highlight><highlight class="preprocessor">#define<sp/>__RAMDRIVE_H_</highlight></codeline>
<codeline lineno="32"><highlight class="preprocessor"></highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="33"><highlight class="normal"></highlight><highlight class="preprocessor">#include<sp/>&lt;<ref refid="ubixfsv2_2device_8h" kindref="compound">device.h</ref>&gt;</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="34"><highlight class="normal"></highlight></codeline>
<codeline lineno="35"><highlight class="normal"></highlight><highlight class="keywordtype">int</highlight><highlight class="normal"><sp/><sp/><sp/><sp/><sp/><sp/><sp/><ref refid="ramdrive_8cpp_1788c47c723973c46800d667ee8eaa979" kindref="member">dev_ramDestroy</ref>();</highlight></codeline>
<codeline lineno="36"><highlight class="normal"><ref refid="structdevice__t" kindref="compound">device_t</ref><sp/>*<ref refid="ramdrive_8cpp_1fc84c5ce562d095ec8a54c428f416ff1" kindref="member">dev_ramDrive</ref>();</highlight></codeline>
<codeline lineno="37"><highlight class="normal"></highlight></codeline>
<codeline lineno="38"><highlight class="normal"></highlight><highlight class="preprocessor">#endif</highlight></codeline>
<codeline lineno="39"><highlight class="preprocessor"></highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="40"><highlight class="normal"></highlight><highlight class="comment">/***</highlight></codeline>
<codeline lineno="41"><highlight class="comment"><sp/>$Log: ramdrive_8h.xml,v $
<codeline lineno="41"><highlight class="comment"><sp/>Revision 1.4  2006/12/12 14:09:15  reddawg
<codeline lineno="41"><highlight class="comment"><sp/>Changes
<codeline lineno="41"><highlight class="comment"><sp/></highlight></codeline>
<codeline lineno="42"><highlight class="comment"><sp/>Revision<sp/>1.1.1.1<sp/><sp/>2006/06/01<sp/>12:46:15<sp/><sp/>reddawg</highlight></codeline>
<codeline lineno="43"><highlight class="comment"><sp/>ubix2</highlight></codeline>
<codeline lineno="44"><highlight class="comment"></highlight></codeline>
<codeline lineno="45"><highlight class="comment"><sp/>Revision<sp/>1.2<sp/><sp/>2005/10/12<sp/>00:13:38<sp/><sp/>reddawg</highlight></codeline>
<codeline lineno="46"><highlight class="comment"><sp/>Removed</highlight></codeline>
<codeline lineno="47"><highlight class="comment"></highlight></codeline>
<codeline lineno="48"><highlight class="comment"><sp/>Revision<sp/>1.1.1.1<sp/><sp/>2005/09/26<sp/>17:24:45<sp/><sp/>reddawg</highlight></codeline>
<codeline lineno="49"><highlight class="comment"><sp/>no<sp/>message</highlight></codeline>
<codeline lineno="50"><highlight class="comment"></highlight></codeline>
<codeline lineno="51"><highlight class="comment"><sp/>Revision<sp/>1.1<sp/><sp/>2004/09/13<sp/>15:21:26<sp/><sp/>flameshadow</highlight></codeline>
<codeline lineno="52"><highlight class="comment"><sp/>add:<sp/>ramdrive.h</highlight></codeline>
<codeline lineno="53"><highlight class="comment"><sp/>chg:<sp/>renamed<sp/>device_t.size<sp/>to<sp/>sectors</highlight></codeline>
<codeline lineno="54"><highlight class="comment"><sp/>chg:<sp/>made<sp/>#define<sp/>for<sp/>size<sp/>of<sp/>ramdisk</highlight></codeline>
<codeline lineno="55"><highlight class="comment"><sp/>chg:<sp/>calculated<sp/>sectors<sp/>of<sp/>ramdisk<sp/>and<sp/>stored<sp/>in<sp/>the<sp/>device_t<sp/>struct</highlight></codeline>
<codeline lineno="56"><highlight class="comment"></highlight></codeline>
<codeline lineno="57"><highlight class="comment"><sp/>Revision<sp/>1.1<sp/><sp/>2004/08/13<sp/>21:47:49<sp/><sp/>reddawg</highlight></codeline>
<codeline lineno="58"><highlight class="comment"><sp/>Fixed</highlight></codeline>
<codeline lineno="59"><highlight class="comment"></highlight></codeline>
<codeline lineno="60"><highlight class="comment"><sp/>END</highlight></codeline>
<codeline lineno="61"><highlight class="comment"><sp/>***/</highlight><highlight class="normal"></highlight></codeline>
<codeline lineno="62"><highlight class="normal"></highlight></codeline>
    </programlisting>
    <location file="/usr/home/reddawg/source/ubix2/src/sys/ubixfsv2/ramdrive.h"/>
  </compounddef>
</doxygen>