1    /* 
     2     * Copyright (c) 2012, 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     *  ======== OsalFactory.xdc ========
    35     */
    36    
    37    import xdc.runtime.Error;
    38    import xdc.runtime.knl.ISemaphore;
    39    
    40    /*!
    41     *  ======== OsalFactory ========
    42     *  Factory to create osal objects.
    43     *
    44     *  createSem() creates either a SemaphoreMP or a Semaphore object, depending
    45     *  on ti.sdo.fc.Settings.multiProcess. This function returns the Semaphore
    46     *  or SemaphoreMP handle cast as an ISemaphore handle. This allows
    47     *  the caller to use the ISemaphore functions (eg, pend(), post()),
    48     *  without having to make a check on whether to use Semaphore functions
    49     *  or SemaphoreMP functions on the handle.
    50     */
    51    
    52    module OsalFactory {
    53    
    54        /*!
    55         *  ======== createSem ========
    56         *  Create a SemaphoreMP object if ti.sdo.fc.Settings.multiProcess is true,
    57         *  otherwise create a Semaphore object.
    58         *
    59         *  @param(count)   The count to initialize the semaphore with
    60         *  @param(key)     A key for multi-process semaphore (if needed).
    61         *  @a(returns)     The Semaphore or SemaphoreMP handle, cast as an
    62         *                  ISemaphore handle.
    63         */
    64        ISemaphore.Handle createSem(Int count, Int key, Error.Block *eb);
    65    
    66        /*!
    67         *  ======== deleteSem ========
    68         *  Delete the semaphore created in createSem().
    69         *
    70         *  @param(h)       Handle returned by createSem().
    71         */
    72        Void deleteSem(ISemaphore.Handle h);
    73    }
    74    /*
    75     *  @(#) ti.sdo.fc.utils.osal; 1, 0, 0,3; 4-16-2012 00:02:50; /db/atree/library/trees/fc/fc-q08/src/ xlibrary
    76    
    77     */
    78