1    /* 
     2     * Copyright (c) 2010, 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    
    34    /*!
    35     *  ======== SHMBUF ========
    36     *  Linux shared memory IRES Resman and Protocol Implementation
    37     */
    38    @Template("./SHMBUF.xdt")
    39    
    40    metaonly module SHMBUF {
    41    
    42        /*!
    43         *  ======== persistentAllocFxn ========
    44         *  Function for allocating memory for SHMBUF's internal objects.
    45         */
    46        config String persistentAllocFxn = null;
    47     
    48        /*!
    49         *  ======== persistentFreeFxn ========
    50         *  Function for freeing memory used by SHMBUF implementation's
    51         *  internal objects.
    52         *
    53         *  This is not required to be set.
    54         */
    55        config String persistentFreeFxn = null;
    56    
    57        /*!
    58         *  ======== key ========
    59         *  Key to identify buffer.
    60         */
    61        config UInt32 key = 0x53425546; /* "SBUF" */
    62    
    63        /*!
    64         *  ======== bufsize ========
    65         *  The length of the buffer resource.
    66         */
    67        config UInt32 bufsize = 0;
    68    
    69        /*!
    70         *  ======== isShared ========
    71         *  Can the buffer be assigned to multiple algorithms? If so, algorithms
    72         *  should not access the buffer simultaneously.
    73         */
    74        config bool isShared = true;
    75    
    76        config Bool enableLog;
    77    
    78        /*  @_nodoc */
    79        // Set to false until SHMBUFCFG_getIresmanFxns() and
    80        // SHMBUFCFG_getDefaultParams() are implemented.
    81        //override config Bool autoRegister = false;
    82    }
    83    
    84    /*
    85     *  @(#) ti.sdo.fc.ires.shmbuf; 1, 0, 0,180; 11-2-2010 18:26:32; /db/atree/library/trees/fc/fc-n22x/src/ xlibrary
    86    
    87     */
    88