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     *  ======== SyncSem.xdc ========
    34     *
    35     */
    36    
    37    import xdc.rov.ViewInfo;
    38    
    39    import ti.sysbios.knl.Semaphore;
    40    
    41    /*!
    42     *  ======== SyncSem ========
    43     *  Implements ISyncs using semaphores.
    44     *
    45     *  Module that implements {@link xdc.runtime.knl.ISync} using
    46     *  {@link ti.sysbios.knl.Semaphore}
    47     *
    48     *  This module uses {@link ti.sysbios.knl.Semaphore#pend} to implement
    49     *  {@link xdc.runtime.knl.ISync#wait} and {@link ti.sysbios.knl.Semaphore#post}
    50     *  to implement {@link xdc.runtime.knl.ISync#signal}.
    51     *
    52     *  Modules like {@link ti.sdo.io.Stream} use an ISync.Handle for
    53     *  selecting the synchronization mechanism. This allows Stream to be
    54     *  independent of the synchronization mechanism.
    55     *
    56     *  An instance of SyncSem requires a Semaphore.Handle. When given a null
    57     *  Semaphore.Handle, SynSem will create a Semaphore for its use. Note that
    58     *  the underlying Semaphore has to be binary in nature and initialized as
    59     *  being unavailable.
    60     */
    61    
    62    @InstanceFinalize
    63    @InstanceInitError
    64    
    65    module SyncSem inherits xdc.runtime.knl.ISync 
    66    {
    67    
    68        /*!
    69         *  ======== BasicView ========
    70         *  @_nodoc
    71         */
    72        metaonly struct BasicView {
    73            String label;
    74            String SemaphoreHandle;
    75            String pendedTasks[];
    76        }
    77        
    78        /*!
    79         *  ======== rovViewInfo ========
    80         *  @_nodoc
    81         */
    82        @Facet
    83        metaonly config ViewInfo.Instance rovViewInfo = 
    84            ViewInfo.create({
    85                viewMap: [
    86                    ['Basic', {type: ViewInfo.INSTANCE, viewInitFxn: 'viewInitBasic', structName: 'BasicView'}],
    87                ]
    88            });
    89    
    90    instance:
    91    
    92        /*! 
    93         *  Semaphore handle to be used. When Semaphore.Handle is null SyncSem 
    94         *  will create a Semaphore instance.
    95         */  
    96        config Semaphore.Handle sem = null;
    97        
    98    internal:
    99    
   100        /* -------- Internal Structures -------- */
   101        struct Instance_State {
   102            Bool                userSem;
   103            Semaphore.Handle    sem;
   104        };
   105    
   106    }
   107    /*
   108     *  @(#) ti.sysbios.syncs; 2, 0, 0, 0,376; 2-24-2012 11:41:11; /db/vtree/library/trees/avala/avala-q28x/src/ xlibrary
   109    
   110     */
   111