1/*
2 * Copyright (c) 2017-2018 Cavium, Inc.
3 * All rights reserved.
4 *
5 *  Redistribution and use in source and binary forms, with or without
6 *  modification, are permitted provided that the following conditions
7 *  are met:
8 *
9 *  1. Redistributions of source code must retain the above copyright
10 *     notice, this list of conditions and the following disclaimer.
11 *  2. Redistributions in binary form must reproduce the above copyright
12 *     notice, this list of conditions and the following disclaimer in the
13 *     documentation and/or other materials provided with the distribution.
14 *
15 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
19 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 *  POSSIBILITY OF SUCH DAMAGE.
26 *
27 * $FreeBSD$
28 *
29 */
30
31#ifndef __ECORE_SP_API_H__
32#define __ECORE_SP_API_H__
33
34#include "ecore_status.h"
35
36enum spq_mode {
37	ECORE_SPQ_MODE_BLOCK,   /* Client will poll a designated mem. address */
38	ECORE_SPQ_MODE_CB,  /* Client supplies a callback */
39	ECORE_SPQ_MODE_EBLOCK,  /* ECORE should block until completion */
40};
41
42struct ecore_hwfn;
43union event_ring_data;
44struct eth_slow_path_rx_cqe;
45
46struct ecore_spq_comp_cb {
47	void	(*function)(struct ecore_hwfn *,
48			 void *,
49			 union event_ring_data *,
50			 u8 fw_return_code);
51	void	*cookie;
52};
53
54
55/**
56 * @brief ecore_eth_cqe_completion - handles the completion of a
57 *        ramrod on the cqe ring
58 *
59 * @param p_hwfn
60 * @param cqe
61 *
62 * @return enum _ecore_status_t
63 */
64enum _ecore_status_t ecore_eth_cqe_completion(struct ecore_hwfn *p_hwfn,
65					      struct eth_slow_path_rx_cqe *cqe);
66/**
67 * @brief ecore_sp_pf_update_tunn_cfg - PF Function Tunnel configuration
68 *					update  Ramrod
69 *
70 * This ramrod is sent to update a tunneling configuration
71 * for a physical function (PF).
72 *
73 * @param p_hwfn
74 * @param p_ptt
75 * @param p_tunn - pf update tunneling parameters
76 * @param comp_mode - completion mode
77 * @param p_comp_data - callback function
78 *
79 * @return enum _ecore_status_t
80 */
81
82enum _ecore_status_t
83ecore_sp_pf_update_tunn_cfg(struct ecore_hwfn *p_hwfn,
84			    struct ecore_ptt *p_ptt,
85			    struct ecore_tunnel_info *p_tunn,
86			    enum spq_mode comp_mode,
87			    struct ecore_spq_comp_cb *p_comp_data);
88#endif
89