1    /*
     2     * Copyright (c) 2017, 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     *  ======== SysCall.xdc ========
    34     */
    35    
    36    package ti.sysbios.family.arm.v7m;
    37    
    38    import xdc.runtime.Error;
    39    
    40    import ti.sysbios.interfaces.ISysCall;
    41    
    42    /*!
    43     *  ======== SysCall ========
    44     *  System Call Manager
    45     */
    46    
    47    @ModuleStartup      /* generate a call to startup function */
    48    
    49    module SysCall inherits ti.sysbios.interfaces.ISysCall
    50    {
    51        //  -------- Module Constants --------
    52    
    53        const UInt16 NUM_SYSCALLS = 3;
    54    
    55        //  -------- Module Types --------
    56    
    57        /*! Callback function type definition. */
    58        typedef Void (*FuncPtr)(UArg);
    59    
    60        //  -------- Module Errors --------
    61    
    62        /*!
    63         *  Error raised when a User Task attempts to switch privilege mode.
    64         *
    65         *  This error is raised by the system call handler if the caller's
    66         *  PC does not fall within the kernel wrapper function section. This
    67         *  typically happens if a User Task attempts to directly invoke a
    68         *  system call to switch the CPU's privileged mode.
    69         */
    70        config Error.Id E_requestFailed  = {
    71            msg: "E_requestFailed: Request (Svc #%d) to switch CPU privilege denied."
    72        };
    73    
    74        //  -------- Module Config --------
    75    
    76        /*!
    77         *  ======== requestFailedFunc ========
    78         *  Callback function for when a system call request is denied.
    79         *  Default is set to an internal function that raises an error.
    80         *
    81         *  If the validation check performed by the system call handler fails,
    82         *  the request is denied and this function is called.
    83         */
    84        config FuncPtr requestFailedFunc;
    85    
    86        //  -------- Module Functions --------
    87    
    88        @Macro
    89        override Void enterPrivMode();
    90    
    91        @Macro
    92        override Void enterUnprivMode();
    93    
    94        @Macro
    95        override Void restorePrivMode();
    96    
    97    internal:
    98    
    99        /*
   100         *  ======== requestFailed ========
   101         */
   102        Void requestFailed(UArg svcNum);
   103    
   104        /*
   105         *  ======== enterPrivModeI ========
   106         */
   107        Void enterPrivModeI();
   108    
   109        /*
   110         *  ======== enterUnprivModeI ========
   111         */
   112        Void enterUnprivModeI();
   113    
   114        /*
   115         *  ======== restorePrivModeI ========
   116         */
   117        Void restorePrivModeI();
   118    
   119        /*
   120         *  ======== svcHandler ========
   121         */
   122        Void svcHandler();
   123    
   124        /*! Module state */
   125        struct Module_State {
   126            Ptr sysCallTable[];     // System call function table
   127        }
   128    }