xref: /freebsd/sys/dev/al_eth/al_init_eth_kr.h (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
1 /*-
2  * Copyright (c) 2015,2016 Annapurna Labs Ltd. and affiliates
3  * All rights reserved.
4  *
5  * Developed by Semihalf.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * 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 AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /**
30  *  Ethernet
31  *  @{
32  * @file   al_init_eth_kr.h
33  *
34  * @brief auto-negotiation and link training activation sequence
35  *
36  *
37  */
38 
39 #ifndef __AL_INIT_ETH_KR_H__
40 #define __AL_INIT_ETH_KR_H__
41 
42 #include <al_hal_eth_kr.h>
43 #include <al_serdes.h>
44 
45 /**
46  * execute Auto-negotiation process
47  *
48  * @param adapter pointer to the private structure
49  * @param serdes_obj pointer to serdes private structure
50  * @param grp serdes's group
51  * @param lane serdes's lane
52  * @param an_adv pointer to the AN Advertisement Registers structure
53  *        when NULL, the registers will not be updated.
54  * @param partner_adv pointer to the AN Advertisement received from the lp
55  *
56  * @return 0 on success. otherwise on failure.
57  */
58 int al_eth_an_lt_execute(struct al_hal_eth_adapter *adapter,
59 			 struct al_serdes_grp_obj *serdes_obj,
60 			 enum al_serdes_lane	lane,
61 			 struct al_eth_an_adv	*an_adv,
62 			 struct al_eth_an_adv   *partner_adv);
63 
64 #endif /*__AL_INIT_ETH_KR_H__*/
65