xref: /openbmc/qemu/hw/net/rocker/rocker_desc.h (revision 0b2ff2ce)
1 /*
2  * QEMU rocker switch emulation - Descriptor ring support
3  *
4  * Copyright (c) 2014 Scott Feldman <sfeldma@gmail.com>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  */
16 
17 
18 #ifndef _ROCKER_DESC_H_
19 #define _ROCKER_DESC_H_
20 
21 #include "rocker_hw.h"
22 
23 typedef int (desc_ring_consume)(Rocker *r, DescInfo *info);
24 
25 uint16_t desc_buf_size(DescInfo *info);
26 uint16_t desc_tlv_size(DescInfo *info);
27 char *desc_get_buf(DescInfo *info, bool read_only);
28 int desc_set_buf(DescInfo *info, size_t tlv_size);
29 DescRing *desc_get_ring(DescInfo *info);
30 
31 int desc_ring_index(DescRing *ring);
32 bool desc_ring_set_base_addr(DescRing *ring, uint64_t base_addr);
33 uint64_t desc_ring_get_base_addr(DescRing *ring);
34 bool desc_ring_set_size(DescRing *ring, uint32_t size);
35 uint32_t desc_ring_get_size(DescRing *ring);
36 bool desc_ring_set_head(DescRing *ring, uint32_t new);
37 uint32_t desc_ring_get_head(DescRing *ring);
38 uint32_t desc_ring_get_tail(DescRing *ring);
39 void desc_ring_set_ctrl(DescRing *ring, uint32_t val);
40 bool desc_ring_ret_credits(DescRing *ring, uint32_t credits);
41 uint32_t desc_ring_get_credits(DescRing *ring);
42 
43 DescInfo *desc_ring_fetch_desc(DescRing *ring);
44 bool desc_ring_post_desc(DescRing *ring, int status);
45 
46 void desc_ring_set_consume(DescRing *ring, desc_ring_consume *consume,
47                            unsigned vector);
48 unsigned desc_ring_get_msix_vector(DescRing *ring);
49 DescRing *desc_ring_alloc(Rocker *r, int index);
50 void desc_ring_free(DescRing *ring);
51 void desc_ring_reset(DescRing *ring);
52 
53 #endif
54