1 /******************************************************************************* 2 Copyright (C) 2015 Annapurna Labs Ltd. 3 4 This file may be licensed under the terms of the Annapurna Labs Commercial 5 License Agreement. 6 7 Alternatively, this file can be distributed under the terms of the GNU General 8 Public License V2 as published by the Free Software Foundation and can be 9 found at http://www.gnu.org/licenses/gpl-2.0.html 10 11 Alternatively, redistribution and use in source and binary forms, with or 12 without modification, are permitted provided that the following conditions are 13 met: 14 15 * Redistributions of source code must retain the above copyright notice, 16 this list of conditions and the following disclaimer. 17 18 * Redistributions in binary form must reproduce the above copyright 19 notice, this list of conditions and the following disclaimer in 20 the documentation and/or other materials provided with the 21 distribution. 22 23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 24 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 25 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 26 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR 27 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON 30 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 32 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 34 *******************************************************************************/ 35 36 /** 37 * @defgroup group_serdes_api API 38 * SerDes HAL driver API 39 * @ingroup group_serdes SerDes 40 * @{ 41 * 42 * @file al_hal_serdes.h 43 * 44 * @brief Header file for the SerDes HAL driver 45 * 46 */ 47 48 #ifndef __AL_HAL_SERDES_H__ 49 #define __AL_HAL_SERDES_H__ 50 51 #include "al_hal_common.h" 52 #include "al_hal_serdes_interface.h" 53 #include "al_hal_serdes_hssp_regs.h" 54 55 /* *INDENT-OFF* */ 56 #ifdef __cplusplus 57 extern "C" { 58 #endif 59 /* *INDENT-ON* */ 60 61 /** 62 * Initializes a SERDES group object 63 * 64 * @param serdes_regs_base 65 * The SERDES register file base pointer 66 * 67 * @param obj 68 * An allocated, non initialized object context 69 * 70 * @return 0 if no error found. 71 * 72 */ 73 int al_serdes_hssp_handle_init( 74 void __iomem *serdes_regs_base, 75 struct al_serdes_grp_obj *obj); 76 77 78 /* *INDENT-OFF* */ 79 #ifdef __cplusplus 80 } 81 #endif 82 83 /* *INDENT-ON* */ 84 #endif /* __AL_SRDS__ */ 85 86 /** @} end of SERDES group */ 87 88