Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 8287

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.3">
  <compounddef id="gc__job__desc_8h" kind="file">
    <compoundname>gc_job_desc.h</compoundname>
    <includes local="no">gcell/gc_types.h</includes>
    <includes local="no">gcell/gc_job_desc_private.h</includes>
    <includedby refid="gc__job__manager_8h" local="yes">gc_job_manager.h</includedby>
    <incdepgraph>
      <node id="3750">
        <label>gcell/gc_job_desc_private.h</label>
      </node>
      <node id="3749">
        <label>gcell/gc_types.h</label>
      </node>
      <node id="3748">
        <label>gc_job_desc.h</label>
        <link refid="gc_job_desc.h"/>
        <childnode refid="3749" relation="include">
        </childnode>
        <childnode refid="3750" relation="include">
        </childnode>
      </node>
    </incdepgraph>
    <invincdepgraph>
      <node id="3752">
        <label>gc_job_manager.h</label>
        <link refid="gc__job__manager_8h"/>
      </node>
      <node id="3751">
        <label>gc_job_desc.h</label>
        <link refid="gc_job_desc.h"/>
        <childnode refid="3752" relation="include">
        </childnode>
      </node>
    </invincdepgraph>
    <innerclass refid="uniongc__arg__union" prot="public">gc_arg_union</innerclass>
    <innerclass refid="structgc__job__direct__args" prot="public">gc_job_direct_args</innerclass>
    <innerclass refid="structgc__job__ea__arg" prot="public">gc_job_ea_arg</innerclass>
    <innerclass refid="structgc__job__ea__args" prot="public">gc_job_ea_args</innerclass>
    <innerclass refid="structgc__job__desc" prot="public">gc_job_desc</innerclass>
      <sectiondef kind="define">
      <memberdef kind="define" id="gc__job__desc_8h_1ac9691d35d75ad6252e743b2a98227528" prot="public" static="no">
        <name>GCP_UNKNOWN_PROC</name>
        <initializer>((<ref refid="gc__job__desc_8h_1a26e60e5aaade61f7c333ee636940a658" kindref="member">gc_proc_id_t</ref>) -1)</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="58" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="58" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="gc__job__desc_8h_1a57449c575a843bba1bad1cd579a7b47f" prot="public" static="no">
        <name>MAX_ARGS_DIRECT</name>
        <initializer>8</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="77" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="77" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="gc__job__desc_8h_1ae881c2b9d3fc24f7733641da2bdd9d5b" prot="public" static="no">
        <name>MAX_ARGS_EA</name>
        <initializer>8</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="78" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="78" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="gc__job__desc_8h_1ab6fdccbe3e8f3bc73ef8c1ee1f9b8d93" prot="public" static="no">
        <name>GCJD_DMA_GET</name>
        <initializer>0x01</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="134" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="134" bodyend="-1"/>
      </memberdef>
      <memberdef kind="define" id="gc__job__desc_8h_1aa6e1dbacdaa190dc4c67e16e13008b18" prot="public" static="no">
        <name>GCJD_DMA_PUT</name>
        <initializer>0x02</initializer>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="135" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="135" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="enum">
      <memberdef kind="enum" id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dd" prot="public" static="no">
        <name>gc_job_status_t</name>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dda46e9e4fcbd8fde2e6272212f534510d3" prot="public">
          <name>JS_OK</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dda5758f9d18da6edb63fb22ff805948243" prot="public">
          <name>JS_SHUTTING_DOWN</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0ddaa3360875947267cda5198fe81be27611" prot="public">
          <name>JS_TOO_MANY_CLIENTS</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0ddad46c5da7d80a020d07e6bdfc244664ec" prot="public">
          <name>JS_UNKNOWN_PROC</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dda0d6c7edda1caf7f52dacfc8982f79e31" prot="public">
          <name>JS_BAD_DIRECTION</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dda5ee9554e091a1b9c27cd0340c16a425d" prot="public">
          <name>JS_BAD_EAH</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0ddadccc98a7d6a0d85ce35406dd0cd183d7" prot="public">
          <name>JS_BAD_N_DIRECT</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dda919040104b50ea5ba656f0c87fad4c25" prot="public">
          <name>JS_BAD_N_EA</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0ddac93c2b021512129739b937fe8de44e6b" prot="public">
          <name>JS_ARGS_TOO_LONG</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0ddaf8d86aa1f1134fa3dc5a37d54022b391" prot="public">
          <name>JS_BAD_JUJU</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1a8e110a97291b439c37ed61b0931bb0dda8351a496808096c317e3123822441e9e" prot="public">
          <name>JS_BAD_JOB_DESC</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <briefdescription>
<para>final job status </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="62" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="62" bodyend="75"/>
      </memberdef>
      <memberdef kind="enum" id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33" prot="public" static="no">
        <name>gc_tag_t</name>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33a55577f0c3ce2b2c6edfedf2a091ca552" prot="public">
          <name>GCT_S32</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33a0ae612722d4392f72f4d81d47623d48f" prot="public">
          <name>GCT_U32</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33ab1ff5e53f20880004b0977e31dc3c4a8" prot="public">
          <name>GCT_S64</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33adab91f391117f398d92adf15ff13e9f7" prot="public">
          <name>GCT_U64</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33a85530d44eb1b9c880b19ddf3ca66a852" prot="public">
          <name>GCT_FLOAT</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33a4a50a0a0156bffdcc328abcedf809a6f" prot="public">
          <name>GCT_DOUBLE</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33a613689bdf1213f5be4e7fd6af1882a91" prot="public">
          <name>GCT_FLT_CMPLX</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33a7f352afe1992b3dc247a45ab9175a0b0" prot="public">
          <name>GCT_DBL_CMPLX</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <enumvalue id="gc__job__desc_8h_1ad58eccafa48c058796dc4035f2c81c33a0c4da6520981fba79811046a721e52f4" prot="public">
          <name>GCT_EADDR</name>
          <briefdescription>
          </briefdescription>
          <detaileddescription>
          </detaileddescription>
        </enumvalue>
        <briefdescription>
<para>Tag type of &quot;direct&quot; argument. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="89" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="89" bodyend="100"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="var">
      <memberdef kind="variable" id="gc__job__desc_8h_1a26e60e5aaade61f7c333ee636940a658" prot="public" static="no" mutable="no">
        <type>__GC_BEGIN_DECLS typedef uint32_t</type>
        <definition>__GC_BEGIN_DECLS typedef uint32_t gc_proc_id_t</definition>
        <argsstring></argsstring>
        <name>gc_proc_id_t</name>
        <briefdescription>
<para>opaque ID that specifies which code to invoke on the SPE </para>        </briefdescription>
        <detaileddescription>
<para>This file contains the structures that are used to describe how to call &quot;jobs&quot; that execute on the SPEs. A &quot;job&quot; is a task, or piece of work that you want to run on an SPE.</para><para>There is code running in the SPE that knows how to interpret these job descriptions. Thus, in most cases, the overhead of invoking these is very low.</para><para>The whole &quot;job idea&quot; is SPE centric. At first pass, the PPE will be constructing jobs and enqueing them. However, there is nothing in the implementation that prohibits SPEs from creating their own jobs in the future. Also, there is nothing prohibiting SPE-to-SPE DMA&apos;s.</para><para>SPE&apos;s dequeue and &quot;pull&quot; jobs to themselves, do the work, then notify the entity that submitted the job. </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="57" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="57" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="typedef">
      <memberdef kind="typedef" id="gc__job__desc_8h_1a04e8c44079ddd5ef3dae69fa142a86e8" prot="public" static="no">
        <type>union <ref refid="uniongc__arg__union" kindref="compound">gc_arg_union</ref></type>
        <definition>typedef union gc_arg_union gc_arg_union_t</definition>
        <argsstring></argsstring>
        <name>gc_arg_union_t</name>
        <briefdescription>
<para>union for passing &quot;direct&quot; argument </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="117"/>
      </memberdef>
      <memberdef kind="typedef" id="gc__job__desc_8h_1ac4519377e30e62722a93728f41e967ca" prot="public" static="no">
        <type>struct <ref refid="structgc__job__direct__args" kindref="compound">gc_job_direct_args</ref></type>
        <definition>typedef struct gc_job_direct_args gc_job_direct_args_t</definition>
        <argsstring></argsstring>
        <name>gc_job_direct_args_t</name>
        <briefdescription>
<para>&quot;direct&quot; input or output arguments </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="129"/>
      </memberdef>
      <memberdef kind="typedef" id="gc__job__desc_8h_1a3f24f7b228c882bda1fca164f2820006" prot="public" static="no">
        <type>struct <ref refid="structgc__job__ea__arg" kindref="compound">gc_job_ea_arg</ref></type>
        <definition>typedef struct gc_job_ea_arg gc_job_ea_arg_t</definition>
        <argsstring></argsstring>
        <name>gc_job_ea_arg_t</name>
        <briefdescription>
<para>Description of args passed in EA memory. These are DMA&apos;d between EA and LS as specified. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="162"/>
      </memberdef>
      <memberdef kind="typedef" id="gc__job__desc_8h_1aaf241ad9e3f4fabafcbecbbea760298a" prot="public" static="no">
        <type>struct <ref refid="structgc__job__ea__args" kindref="compound">gc_job_ea_args</ref></type>
        <definition>typedef struct gc_job_ea_args gc_job_ea_args_t</definition>
        <argsstring></argsstring>
        <name>gc_job_ea_args_t</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="169"/>
      </memberdef>
      <memberdef kind="typedef" id="group__gcell_1ga1437283a479e08d5d674007709805657" prot="public" static="no">
        <type>struct <ref refid="structgc__job__desc" kindref="compound">gc_job_desc</ref></type>
        <definition>typedef struct gc_job_desc gc_job_desc_t</definition>
        <argsstring></argsstring>
        <name>gc_job_desc_t</name>
        <briefdescription>
<para>&quot;job description&quot; that is DMA&apos;d to/from the SPE. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="185"/>
      </memberdef>
      <memberdef kind="typedef" id="gc__job__desc_8h_1a9bae59106d2eac79cd279a1c5ac3f189" prot="public" static="no">
        <type>void(*</type>
        <definition>typedef void(* gc_spu_proc_t)(const gc_job_direct_args_t *input, gc_job_direct_args_t *output, const gc_job_ea_args_t *eaa)</definition>
        <argsstring>)(const gc_job_direct_args_t *input, gc_job_direct_args_t *output, const gc_job_ea_args_t *eaa)</argsstring>
        <name>gc_spu_proc_t</name>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para>type of procedure invoked on spu </para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="193" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="191" bodyend="-1"/>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="gc__job__desc_8h_1a11df2c8a4aa3d44873b1a02536df8890" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="structgc__job__desc" kindref="compound">gc_job_desc_t</ref> *</type>
        <definition>static gc_job_desc_t* ea_to_jdp</definition>
        <argsstring>(gc_eaddr_t ea)</argsstring>
        <name>ea_to_jdp</name>
        <param>
          <type><ref refid="gc__types_8h_1affc43a8e5ab8551e7361f8ce8521c34d" kindref="member">gc_eaddr_t</ref></type>
          <declname>ea</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="199" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="198" bodyend="201"/>
        <references refid="gc__types_8h_1ae47a2086c488bf070bc37074386c6690" compoundref="gc__types_8h" startline="47" endline="51">ea_to_ptr</references>
      </memberdef>
      <memberdef kind="function" id="gc__job__desc_8h_1a19ce22e388fa08f86b57db98ef854ac6" prot="public" static="yes" const="no" explicit="no" inline="yes" virt="non-virtual">
        <type><ref refid="gc__types_8h_1affc43a8e5ab8551e7361f8ce8521c34d" kindref="member">gc_eaddr_t</ref></type>
        <definition>static gc_eaddr_t jdp_to_ea</definition>
        <argsstring>(gc_job_desc_t *item)</argsstring>
        <name>jdp_to_ea</name>
        <param>
          <type><ref refid="structgc__job__desc" kindref="compound">gc_job_desc_t</ref> *</type>
          <declname>item</declname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" line="205" bodyfile="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h" bodystart="204" bodyend="207"/>
        <references refid="gc__types_8h_1aa8742b54a07724a64b3a4f84163ec7a0" compoundref="gc__types_8h" startline="54" endline="58">ptr_to_ea</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/builddir/build/BUILD/gnuradio-3.2.2/gcell/include/gcell/gc_job_desc.h"/>
  </compounddef>
</doxygen>