Altera HWLIB  16.0
The Altera HW Manager API Reference Manual
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups
alt_bridge_manager.h
Go to the documentation of this file.
1 
5 /******************************************************************************
6 *
7 * Copyright 2013 Altera Corporation. All Rights Reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of the copyright holder nor the names of its contributors
20 * may be used to endorse or promote products derived from this software without
21 * specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 *
35 ******************************************************************************/
36 
37 /*
38  * $Id: //depot/embedded/rel/15.0/ip/hps/altera_hps/hwlib/include/soc_cv_av/alt_bridge_manager.h#1 $
39  */
40 
41 #ifndef __ALT_BRG_MGR_H__
42 #define __ALT_BRG_MGR_H__
43 
44 #include "hwlib.h"
45 
46 #ifdef __cplusplus
47 extern "C"
48 {
49 #endif /* __cplusplus */
50 
51 /******************************************************************************/
70 #ifndef ALT_BRIDGE_PROVISION_F2S_SUPPORT
71 #define ALT_BRIDGE_PROVISION_F2S_SUPPORT (0)
72 #endif
73 
74 /******************************************************************************/
79 typedef enum ALT_BRIDGE_e
80 {
127 #if ALT_BRIDGE_PROVISION_F2S_SUPPORT
128  ,
129  ALT_BRIDGE_F2S
150 #endif
151 } ALT_BRIDGE_t;
152 
153 /******************************************************************************/
182 typedef ALT_STATUS_CODE (*alt_bridge_fpga_is_ready_t)(void* user_arg);
183 
184 /******************************************************************************/
227 ALT_STATUS_CODE alt_bridge_init(ALT_BRIDGE_t bridge,
228  alt_bridge_fpga_is_ready_t fpga_is_ready,
229  void* user_arg);
230 
231 /******************************************************************************/
263 typedef ALT_STATUS_CODE (*alt_bridge_teardown_handshake_t)(void* user_arg);
264 
265 /******************************************************************************/
304 ALT_STATUS_CODE alt_bridge_uninit(ALT_BRIDGE_t bridge,
306  void* user_arg);
307 
310 #ifdef __cplusplus
311 }
312 #endif /* __cplusplus */
313 #endif /* __ALT_BRG_MGR_H__ */