xref: /freebsd/sys/dev/liquidio/base/cn23xx_pf_device.h (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2017 Cavium, Inc.. All rights reserved.
5  *   All rights reserved.
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  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Cavium, Inc. nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /* \file  cn23xx_device.h
35  * \brief Host Driver: Routines that perform CN23XX specific operations.
36  */
37 
38 #ifndef __CN23XX_PF_DEVICE_H__
39 #define __CN23XX_PF_DEVICE_H__
40 
41 #include "cn23xx_pf_regs.h"
42 
43 /*
44  * Register address and configuration for a CN23XX devices.
45  * If device specific changes need to be made then add a struct to include
46  * device specific fields as shown in the commented section
47  */
48 struct lio_cn23xx_pf {
49 	/* PCI interrupt summary register */
50 	uint32_t	intr_sum_reg64;
51 
52 	/* PCI interrupt enable register */
53 	uint32_t	intr_enb_reg64;
54 
55 	/* The PCI interrupt mask used by interrupt handler */
56 	uint64_t	intr_mask64;
57 
58 	struct lio_config *conf;
59 };
60 
61 #define BUSY_READING_REG_PF_LOOP_COUNT	10000
62 
63 int	lio_cn23xx_pf_setup_device(struct octeon_device *oct);
64 
65 uint32_t	lio_cn23xx_pf_get_oq_ticks(struct octeon_device *oct,
66 					   uint32_t time_intr_in_us);
67 
68 int	lio_cn23xx_pf_fw_loaded(struct octeon_device *oct);
69 
70 #endif	/* __CN23XX_PF_DEVICE_H__ */
71