xref: /freebsd/sys/arm/annapurna/alpine/alpine_serdes.h (revision 43a5ec4eb41567cc92586503212743d89686d78f)
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 #ifndef __ALPINE_SERDES_H__
32 #define __ALPINE_SERDES_H__
33 
34 /* SerDes ETH mode */
35 enum alpine_serdes_eth_mode {
36 	ALPINE_SERDES_ETH_MODE_SGMII,
37 	ALPINE_SERDES_ETH_MODE_KR,
38 };
39 
40 /*
41  * Get SerDes group regs base, to be used in relevant Alpine drivers.
42  * Valid group is 0..3.
43  * Returns virtual base address of the group regs base.
44  */
45 void *alpine_serdes_resource_get(uint32_t group);
46 
47 /*
48  * Set SerDes ETH mode for an entire group, unless already set
49  * Valid group is 0..3.
50  * Returns 0 upon success.
51  */
52 int alpine_serdes_eth_mode_set(uint32_t group,
53     enum alpine_serdes_eth_mode mode);
54 
55 /* Lock the all serdes group for using common registers */
56 void alpine_serdes_eth_group_lock(uint32_t group);
57 
58 /* Unlock the all serdes group for using common registers */
59 void alpine_serdes_eth_group_unlock(uint32_t group);
60 
61 #endif /* __ALPINE_SERDES_H__ */
62