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     *  ======== IomAdapter.xdc ========
    34     *
    35     *
    36     *  Open Issues:
    37     *  1. static policy not supported.
    38     *  2. Need to map errors, commands.
    39     *  3. Uarg vs Ptr
    40     */
    41    
    42    import xdc.runtime.Error;
    43    import ti.sdo.io.DriverTypes;
    44    
    45    /*!
    46     * Module through which legacy iom drivers can plug into BIOS 6.x
    47     *
    48     * The IomAdapter module maps iom.h to IDriver.xdc. A legacy iom
    49     * driver has to hook into BIOS 6.x using this module. This module
    50     * handles ALL legacy drivers in the system. This single module
    51     * takes care of several legacy driver modules. 
    52     * 
    53     * As part of its create the IomAdapter module will call mbBindDev for
    54     * each of the legacy drivers. {@link #open} will call mdCreateChan. 
    55     * {@link #close} will call mdDeleteChan. {@link #submit} will call
    56     * mdSubmitChan. {@link #control} will call mdControlChan. A delete call will
    57     * call mdUnbindDev.
    58     *
    59     */
    60    @ModuleStartup
    61    @InstanceFinalize
    62    
    63    module IomAdapter inherits ti.sdo.io.IDriver {      
    64    
    65        /*! Iom init function type definition. */
    66        typedef Void (*InitFunc)();
    67    
    68    instance:
    69    
    70        /*! Pointer to legacy iom function table */
    71        config Ptr iomFxns = null;
    72    
    73        /*! Legacy iom init function */
    74        config InitFunc initFxn = null;
    75    
    76        /*! Legacy deviceParams */
    77        config Ptr deviceParams = null;
    78        
    79        /*! deviceId for iom driver */
    80        config UInt deviceId = 0;
    81        
    82        /*!
    83         *  ======== create ========
    84         *  Create an IomAdapter instance
    85         */
    86        create();
    87        
    88    internal:
    89    
    90        Void driverCallback(Ptr cbArg, DriverTypes.Packet *packet);
    91    
    92        Void postInit(Object *obj);
    93        
    94        Error.Id mapStatus(Int status);
    95    
    96        struct ChanObj {
    97            Ptr                    iomChanHdl;
    98            DriverTypes.DoneFxn    cbFxn;
    99            UArg                   cbArg;
   100            DriverTypes.Packet     abortPkt;
   101        };
   102    
   103        struct Instance_State {
   104            Int            deviceId;
   105            Ptr            deviceParams;
   106            Ptr            deviceHandle;
   107            Ptr            iomFxns;
   108            InitFunc       initFxn;
   109        };
   110    }
   111    /*
   112     *  @(#) ti.sdo.io.drivers; 1, 0, 0, 0,346; 8-10-2010 17:48:30; /db/vtree/library/trees/ipc/ipc-e23x/src/
   113     */
   114