1 //******************************************************************
3 // Copyright 2014 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
24 * This file contains APIs for PIPlugin module to be implemented.
27 #ifndef PLUGININTERFACE_H_
28 #define PLUGININTERFACE_H_
30 #include "plugintypes.h"
38 * Makes any required calls to instantiate plugin's radio.
40 * @param[in] comPort The com port which this plugin is located.
41 * @param[in] pluginType The type of plugin to start.
42 * @param[out] plugin The plugin handle that will be started.
45 OCStackResult PIStartPlugin(const char * comPort, PIPluginType pluginType, PIPlugin ** plugin);
49 * Makes any required calls to stop plugin.
51 * @param[in] plugin The plugin to be stopped.
54 OCStackResult PIStopPlugin(PIPlugin * plugin);
58 * Makes any required calls to stop all plugins.
61 OCStackResult PIStopAll();
65 * Called in main loop of application. Gives cycles for Plugin Interface'
68 * @param[in] plugin The plugin to get cycles from this function's invocation.
71 OCStackResult PIProcess(PIPlugin * plugin);
77 #endif /* PLUGININTERFACE_H_ */