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/*$FreeBSD: stable/11/sys/dev/liquidio/base/cn23xx_pf_device.h 325618 2017-11-09 19:52:56Z sbruno $*/
34
35/* \file  cn23xx_device.h
36 * \brief Host Driver: Routines that perform CN23XX specific operations.
37 */
38
39#ifndef __CN23XX_PF_DEVICE_H__
40#define __CN23XX_PF_DEVICE_H__
41
42#include "cn23xx_pf_regs.h"
43
44/*
45 * Register address and configuration for a CN23XX devices.
46 * If device specific changes need to be made then add a struct to include
47 * device specific fields as shown in the commented section
48 */
49struct lio_cn23xx_pf {
50	/* PCI interrupt summary register */
51	uint32_t	intr_sum_reg64;
52
53	/* PCI interrupt enable register */
54	uint32_t	intr_enb_reg64;
55
56	/* The PCI interrupt mask used by interrupt handler */
57	uint64_t	intr_mask64;
58
59	struct lio_config *conf;
60};
61
62#define BUSY_READING_REG_PF_LOOP_COUNT	10000
63
64int	lio_cn23xx_pf_setup_device(struct octeon_device *oct);
65
66uint32_t	lio_cn23xx_pf_get_oq_ticks(struct octeon_device *oct,
67					   uint32_t time_intr_in_us);
68
69int	lio_cn23xx_pf_fw_loaded(struct octeon_device *oct);
70
71#endif	/* __CN23XX_PF_DEVICE_H__ */
72