Open-AVB AVTP Pipeline SDK  1.4
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
openavb_intf_ctrl_pub.h
Go to the documentation of this file.
1 /*************************************************************************************************************
2 Copyright (c) 2012-2015, Symphony Teleca Corporation, a Harman International Industries, Incorporated company
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 
8 1. Redistributions of source code must retain the above copyright notice, this
9  list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright notice,
11  this list of conditions and the following disclaimer in the documentation
12  and/or other materials provided with the distribution.
13 
14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS LISTED "AS IS" AND
15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS LISTED BE LIABLE FOR
18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 
25 Attributions: The inih library portion of the source code is licensed from
26 Brush Technology and Ben Hoyt - Copyright (c) 2009, Brush Technology and Copyright (c) 2009, Ben Hoyt.
27 Complete license and copyright information can be found at
28 https://github.com/benhoyt/inih/commit/74d2ca064fb293bc60a77b0bd068075b293cf175.
29 *************************************************************************************************************/
30 
31 /*
32 * HEADER SUMMARY : Control interface module public interface
33 */
34 
35 #ifndef OPENAVB_INTF_CTRL_PUB_H
36 #define OPENAVB_INTF_CTRL_PUB_H 1
37 
38 #include "openavb_types_pub.h"
39 
44 typedef void (*openavb_intf_ctrl_receive_cb_t)(void *pTLHandle, U8 *pData, U32 dataLength);
46 
48 typedef bool (*openavb_intf_ctrl_register_receive_control_fn_t)(void *pIntfHandle, void *pTLHandle, openavb_intf_ctrl_receive_cb_t openavbIntfCtrlReceiveCommandCB);
49 
51 typedef bool (*openavb_intf_ctrl_unregister_receive_control_fn_t)(void *pIntfHandle);
52 
54 typedef bool (*openavb_intf_ctrl_send_control_fn_t)(void *pIntfHandle, U8 *pData, U32 dataLength, U32 usecDelay);
55 
57 typedef struct {
65 
66 #endif // OPENAVB_INTF_CTRL_PUB_H
openavb_intf_ctrl_unregister_receive_control_fn_t unregister_receive_control_cb
Unregistering callback function.
Definition: openavb_intf_ctrl_pub.h:61
bool(* openavb_intf_ctrl_unregister_receive_control_fn_t)(void *pIntfHandle)
Register a callback for received control commands.
Definition: openavb_intf_ctrl_pub.h:51
bool(* openavb_intf_ctrl_send_control_fn_t)(void *pIntfHandle, U8 *pData, U32 dataLength, U32 usecDelay)
Submit a control command for transmission.
Definition: openavb_intf_ctrl_pub.h:54
uint8_t U8
Unsigned 8 bit type.
Definition: openavb_types_base_pub.h:77
Callbacks to control functions.
Definition: openavb_intf_ctrl_pub.h:57
uint32_t U32
Unsigned 32 bit type.
Definition: openavb_types_base_pub.h:85
bool(* openavb_intf_ctrl_register_receive_control_fn_t)(void *pIntfHandle, void *pTLHandle, openavb_intf_ctrl_receive_cb_t openavbIntfCtrlReceiveCommandCB)
Register a callback for received control commands.
Definition: openavb_intf_ctrl_pub.h:48
openavb_intf_ctrl_register_receive_control_fn_t register_receive_control_cb
Registering callback function.
Definition: openavb_intf_ctrl_pub.h:59
void(* openavb_intf_ctrl_receive_cb_t)(void *pTLHandle, U8 *pData, U32 dataLength)
This callback once registered will be called for each control command received by the listener...
Definition: openavb_intf_ctrl_pub.h:45
openavb_intf_ctrl_send_control_fn_t send_control_cb
Submitting control command.
Definition: openavb_intf_ctrl_pub.h:63