Remove implementation details from ArgInfo
[tidl/tidl-api.git] / tidl_api / src / device_arginfo.h
1 /******************************************************************************
2  * Copyright (c) 2017-2018 Texas Instruments Incorporated - http://www.ti.com/
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 are met:
7  *      * Redistributions of source code must retain the above copyright
8  *        notice, this list of conditions and the following disclaimer.
9  *      * Redistributions in binary form must reproduce the above copyright
10  *        notice, this list of conditions and the following disclaimer in the
11  *        documentation and/or other materials provided with the distribution.
12  *      * Neither the name of Texas Instruments Incorporated nor the
13  *        names of its contributors may be used to endorse or promote products
14  *        derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26  *  THE POSSIBILITY OF SUCH DAMAGE.
27  *****************************************************************************/
29 //! @file device_arginfo.h
31 #pragma once
33 #include "executor.h"
35 namespace tidl
36 {
38 /*! @class DeviceArgInfo
39  *  @brief Describe input and output buffers required by ExecutionObjects
40  */
41 class DeviceArgInfo: public ArgInfo
42 {
43     public:
44         //! Enumerates the types of arguments represented by DeviceArgInfo
45         enum class Kind { BUFFER=0, LOCAL, SCALAR };
47         //! Construct an DeviceArgInfo object
48         DeviceArgInfo(const ArgInfo& ai, Kind kind) :
49             ArgInfo(ai), kind_m(kind)
50         {}
52         DeviceArgInfo(void *p, size_t size, Kind kind) :
53             ArgInfo(p, size), kind_m(kind)
54         {}
56         Kind   kind() const { return kind_m; }
57         bool   isLocal() const { return (ptr_m == nullptr) && (size_m > 0); }
59     private:
60         Kind         kind_m;
61 };
63 } //namespace