xref: /dpdk/drivers/net/octeontx/base/octeontx_bgx.h (revision 4d02788045dace71fc83563c7506116e6d98a546)
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright (C) Cavium Inc. 2017. All rights reserved.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  *       notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above copyright
13  *       notice, this list of conditions and the following disclaimer in
14  *       the documentation and/or other materials provided with the
15  *       distribution.
16  *     * Neither the name of Cavium networks nor the names of its
17  *       contributors may be used to endorse or promote products derived
18  *       from this software without specific prior written permission.
19  *
20  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef __OCTEONTX_BGX_H__
34 #define __OCTEONTX_BGX_H__
35 
36 #include <stddef.h>
37 #include <stdint.h>
38 
39 #include <rte_pmd_octeontx_ssovf.h>
40 
41 #define OCTEONTX_BGX_COPROC	        6
42 
43 /* BGX messages */
44 #define MBOX_BGX_PORT_OPEN              0
45 #define MBOX_BGX_PORT_CLOSE             1
46 #define MBOX_BGX_PORT_START             2
47 #define MBOX_BGX_PORT_STOP              3
48 
49 /* BGX port configuration parameters: */
50 typedef struct octeontx_mbox_bgx_port_conf {
51 	uint8_t enable;
52 	uint8_t promisc;
53 	uint8_t bpen;
54 	uint8_t macaddr[6]; /* MAC address.*/
55 	uint8_t fcs_strip;
56 	uint8_t bcast_mode;
57 	uint8_t mcast_mode;
58 	uint8_t node; /* CPU node */
59 	uint16_t base_chan;
60 	uint16_t num_chans;
61 	uint16_t mtu;
62 	uint8_t bgx;
63 	uint8_t lmac;
64 	uint8_t mode;
65 	uint8_t pkind;
66 } octeontx_mbox_bgx_port_conf_t;
67 
68 int octeontx_bgx_port_open(int port, octeontx_mbox_bgx_port_conf_t *conf);
69 int octeontx_bgx_port_close(int port);
70 int octeontx_bgx_port_start(int port);
71 int octeontx_bgx_port_stop(int port);
72 
73 #endif	/* __OCTEONTX_BGX_H__ */
74 
75