1    /*
     2     * Copyright (c) 2012-2013, Texas Instruments Incorporated
     3     * All rights reserved.
     4     *
     5     * Redistribution and use in source and binary forms, with or without
     6     * modification, are permitted provided that the following conditions
     7     * are met:
     8     *
     9     * *  Redistributions of source code must retain the above copyright
    10     *    notice, this list of conditions and the following disclaimer.
    11     *
    12     * *  Redistributions in binary form must reproduce the above copyright
    13     *    notice, this list of conditions and the following disclaimer in the
    14     *    documentation and/or other materials provided with the distribution.
    15     *
    16     * *  Neither the name of Texas Instruments Incorporated nor the names of
    17     *    its contributors may be used to endorse or promote products derived
    18     *    from this software without specific prior written permission.
    19     *
    20     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    21     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
    22     * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    23     * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    24     * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    25     * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    26     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
    27     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
    28     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
    29     * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
    30     * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    31     */
    32    /*
    33     *  ======== package.xdc ========
    34     *
    35     */
    36    
    37    /*!
    38     *  ======== ti.ipc ========
    39     *  Inter processor communication common headers
    40     *
    41     *  This is a package that serves as a container for common header files
    42     *  for various IPC modules supplied with the IPC product.
    43     *
    44     *  @p(html)
    45     *  Documentation for all runtime APIs, instance configuration parameters,
    46     *  error codes macros and type definitions available to the application
    47     *  integrator can be found in the
    48     *  <A HREF="../../../doxygen/html/files.html">Doxygen documentation</A>
    49     *  for the IPC product.  However, the documentation presented in RTSC cdoc
    50     *  should be referred to for information specific to the RTSC module, such as
    51     *  module configuration, Errors, and Asserts.
    52     *  @p
    53     *
    54     *  The following table shows a list of all IPC modules that have common header
    55     *  files.  Follow the corresponding links for doxygen or cdoc documentation
    56     *  for each of the modules.
    57     *
    58     *  @p(html)
    59     *  <TABLE BORDER="1">
    60     *  <COLGROUP STYLE="font-weight: bold; color: rgb(0,127,102);"></COLGROUP>
    61     *  <COLGROUP></COLGROUP>
    62     *  <COLGROUP></COLGROUP>
    63     *  <COLGROUP></COLGROUP>
    64     *  <TR>
    65     *      <TD>GateMP</TD>
    66     *      <TD>Multiple processor gate that provides local and remote context protection</TD>
    67     *      <TD><A HREF="../../../doxygen/html/_gate_m_p_8h.html">Doxygen</A></TD>
    68     *      <TD><A HREF="../sdo/ipc/GateMP.html">cdoc</A></TD>
    69     *  </TR>
    70     *  <TR>
    71     *      <TD>HeapBufMP</TD>
    72     *      <TD>Multi-processor fixed-size buffer heap</TD>
    73     *      <TD><A HREF="../../../doxygen/html/_heap_buf_m_p_8h.html">Doxygen</A></TD>
    74     *      <TD><A HREF="../sdo/ipc/heaps/HeapBufMP.html">cdoc</A></TD>
    75     *  </TR>
    76     *  <TR>
    77     *      <TD>HeapMemMP</TD>
    78     *      <TD>Multi-processor variable size buffer heap </TD>
    79     *      <TD><A HREF="../../../doxygen/html/_heap_mem_m_p_8h.html">Doxygen</A></TD>
    80     *      <TD><A HREF="../sdo/ipc/heaps/HeapMemMP.html">cdoc</A></TD>
    81     *  </TR>
    82     *  <TR>
    83     *      <TD>HeapMultiBufMP</TD>
    84     *      <TD>Multiple fixed size buffer heap</TD>
    85     *      <TD><A HREF="../../../doxygen/html/_heap_multi_buf_m_p_8h.html">Doxygen</A></TD>
    86     *      <TD><A HREF="../sdo/ipc/heaps/HeapMultiBufMP.html">cdoc</A></TD>
    87     *  </TR>
    88     *  <TR>
    89     *      <TD>Ipc</TD>
    90     *      <TD>Ipc Manager</TD>
    91     *      <TD><A HREF="../../../doxygen/html/_ipc_8h.html">Doxygen</A></TD>
    92     *      <TD><A HREF="../sdo/ipc/Ipc.html">cdoc</A></TD>
    93     *  </TR>
    94     *  <TR>
    95     *      <TD>ListMP</TD>
    96     *      <TD>Multiple processor shared memory list</TD>
    97     *      <TD><A HREF="../../../doxygen/html/_list_m_p_8h.html">Doxygen</A></TD>
    98     *      <TD><A HREF="../sdo/ipc/ListMP.html">cdoc</A></TD>
    99     *  </TR>
   100     *  <TR>
   101     *      <TD>MessageQ</TD>
   102     *      <TD>Message-passing with queuing</TD>
   103     *      <TD><A HREF="../../../doxygen/html/_message_q_8h.html">Doxygen</A></TD>
   104     *      <TD><A HREF="../sdo/ipc/MessageQ.html">cdoc</A></TD>
   105     *  </TR>
   106     *  <TR>
   107     *      <TD>MultiProc</TD>
   108     *      <TD>Processor id manager</TD>
   109     *      <TD><A HREF="../../../doxygen/html/_multi_proc_8h.html">Doxygen</A></TD>
   110     *      <TD><A HREF="../sdo/utils/MultiProc.html">cdoc</A></TD>
   111     *  </TR>
   112     *  <TR>
   113     *      <TD>NameServer</TD>
   114     *      <TD>Name manager</TD>
   115     *      <TD><A HREF="../../../doxygen/html/_name_server_8h.html">Doxygen</A></TD>
   116     *      <TD><A HREF="../sdo/utils/NameServer.html">cdoc</A></TD>
   117     *  </TR>
   118     *  <TR>
   119     *      <TD>Notify</TD>
   120     *      <TD>Notification manager for IPC</TD>
   121     *      <TD><A HREF="../../../doxygen/html/_notify_8h.html">Doxygen</A></TD>
   122     *      <TD><A HREF="../sdo/ipc/Notify.html">cdoc</A></TD>
   123     *  </TR>
   124     *  <TR>
   125     *      <TD>SharedRegion</TD>
   126     *      <TD>Shared memory manager and address translator </TD>
   127     *      <TD><A HREF="../../../doxygen/html/_shared_region_8h.html">Doxygen</A></TD>
   128     *      <TD><A HREF="../sdo/ipc/SharedRegion.html">cdoc</A></TD>
   129     *  </TR>
   130     *
   131     *  </TABLE>
   132     *  @p
   133     *
   134     */
   135    
   136    package ti.ipc [1,0,0,0] {
   137    
   138    }