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 * $FreeBSD$
29 */
30
31/**
32 *  Ethernet
33 *  @{
34 * @file   al_init_eth_kr.h
35 *
36 * @brief auto-negotiation and link training activation sequence
37 *
38 *
39 */
40
41#ifndef __AL_INIT_ETH_KR_H__
42#define __AL_INIT_ETH_KR_H__
43
44#include <al_hal_eth_kr.h>
45#include <al_serdes.h>
46
47/**
48 * execute Auto-negotiation process
49 *
50 * @param adapter pointer to the private structure
51 * @param serdes_obj pointer to serdes private structure
52 * @param grp serdes's group
53 * @param lane serdes's lane
54 * @param an_adv pointer to the AN Advertisement Registers structure
55 *        when NULL, the registers will not be updated.
56 * @param partner_adv pointer to the AN Advertisement received from the lp
57 *
58 * @return 0 on success. otherwise on failure.
59 */
60int al_eth_an_lt_execute(struct al_hal_eth_adapter *adapter,
61			 struct al_serdes_grp_obj *serdes_obj,
62			 enum al_serdes_lane	lane,
63			 struct al_eth_an_adv	*an_adv,
64			 struct al_eth_an_adv   *partner_adv);
65
66#endif /*__AL_INIT_ETH_KR_H__*/
67