xref: /freebsd/sys/dev/qcom_ess_edma/qcom_ess_edma_desc.h (revision 9f32893b05dabedc7f8332ec12e2a944b6543158)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2021 Adrian Chadd <adrian@FreeBSD.org>.
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  * 1. Redistributions of source code must retain the above copyright
10  *    notice unmodified, this list of conditions, and the following
11  *    disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  *
30  */
31 
32 #ifndef	__QCOM_ESS_EDMA_DESC_H__
33 #define	__QCOM_ESS_EDMA_DESC_H__
34 
35 extern	int qcom_ess_edma_desc_ring_setup(struct qcom_ess_edma_softc *sc,
36 	    struct qcom_ess_edma_desc_ring *ring,
37 	    char *label,
38 	    int count,
39 	    int sw_desc_size,
40 	    int hw_desc_size,
41 	    int num_segments,
42 	    int buffer_alignment);
43 extern	int qcom_ess_edma_desc_ring_free(struct qcom_ess_edma_softc *sc,
44 	    struct qcom_ess_edma_desc_ring *ring);
45 extern	void * qcom_ess_edma_desc_ring_get_sw_desc(
46 	    struct qcom_ess_edma_softc *sc,
47 	    struct qcom_ess_edma_desc_ring *ring,
48 	    uint16_t index);
49 extern	void * qcom_ess_edma_desc_ring_get_hw_desc(
50 	    struct qcom_ess_edma_softc *sc,
51 	    struct qcom_ess_edma_desc_ring *ring,
52 	    uint16_t index);
53 extern	int qcom_ess_edma_desc_ring_flush_preupdate(
54 	    struct qcom_ess_edma_softc *sc,
55 	    struct qcom_ess_edma_desc_ring *ring);
56 extern	int qcom_ess_edma_desc_ring_flush_postupdate(
57 	    struct qcom_ess_edma_softc *sc,
58 	    struct qcom_ess_edma_desc_ring *ring);
59 extern	int qcom_ess_edma_desc_ring_get_num_available(
60 	    struct qcom_ess_edma_softc *sc,
61 	    struct qcom_ess_edma_desc_ring *ring);
62 
63 #endif	/* __QCOM_ESS_EDMA_DESC_H__ */
64