---

k3-ringacc.h

/* SPDX-License-Identifier: GPL-2.0 */ /* * K3 Ring Accelerator (RA) subsystem interface * * Copyright (C) 2019 Texas Instruments Incorporated - https://www.ti.com */ #ifndef __SOC_TI_K3_RINGACC_API_H_ #define __SOC_TI_K3_RINGACC_API_H_ #include <linux/types.h> struct device_node; /** * enum k3_ring_mode - &struct k3_ring_cfg mode * * RA ring operational modes * * @K3_RINGACC_RING_MODE_RING: Exposed Ring mode for SW direct access * @K3_RINGACC_RING_MODE_MESSAGE: Messaging mode. Messaging mode requires * that all accesses to the queue must go through this IP so that all * accesses to the memory are controlled and ordered. This IP then * controls the entire state of the queue, and SW has no directly control, * such as through doorbells and cannot access the storage memory directly. * This is particularly useful when more than one SW or HW entity can be * the producer and/or consumer at the same time * @K3_RINGACC_RING_MODE_CREDENTIALS: Credentials mode is message mode plus * stores credentials with each message, requiring the element size to be * doubled to fit the credentials. Any exposed memory should be protected * by a firewall from unwanted access */ enum k3_ring_mode { K3_RINGACC_RING_MODE_RING = 0, K3_RINGACC_RING_MODE_MESSAGE, K3_RINGACC_RING_MODE_CREDENTIALS, K3_RINGACC_RING_MODE_INVALID }; /** * enum k3_ring_size - &struct k3_ring_cfg elm_size * * RA ring element's sizes in bytes. */ enum k3_ring_size { K3_RINGACC_RING_ELSIZE_4 = 0, K3_RINGACC_RING_ELSIZE_8, K3_RINGACC_RING_ELSIZE_16, K3_RINGACC_RING_ELSIZE_32, K3_RINGACC_RING_ELSIZE_64, K3_RINGACC_RING_ELSIZE_128, K3_RINGACC_RING_ELSIZE_256, K3_RINGACC_RING_ELSIZE_INVALID }; struct k3_ringacc; struct k3_ring; /** * enum k3_ring_cfg - RA ring configuration structure * * @size: Ring size, number of elements * @elm_size: Ring element size * @mode: Ring operational mode * @flags: Ring configuration flags. Possible values: * @K3_RINGACC_RING_SHARED: when set allows to request the same ring * few times. It's usable when the same ring is used as Free Host PD ring * for different flows, for example. * Note: Locking should be done by consumer if required * @dma_dev: Master device which is using and accessing to the ring * memory when the mode is K3_RINGACC_RING_MODE_RING. Memory allocations * should be done using this device. * @asel: Address Space Select value for physical addresses */ struct k3_ring_cfg { u32 size; enum k3_ring_size elm_size; enum k3_ring_mode mode; #define K3_RINGACC_RING_SHARED BIT(1) u32 flags; struct device *dma_dev; u32 asel; }; #define K3_RINGACC_RING_ID_ANY (-1) /** * of_k3_ringacc_get_by_phandle - find a RA by phandle property * @np: device node * @propname: property name containing phandle on RA node * * Returns pointer on the RA - struct k3_ringacc * or -ENODEV if not found, * or -EPROBE_DEFER if not yet registered */ struct k3_ringacc *of_k3_ringacc_get_by_phandle(struct device_node *np, const char *property); #define K3_RINGACC_RING_USE_PROXY BIT(1) /** * k3_ringacc_request_ring - request ring from ringacc * @ringacc: pointer on ringacc * @id: ring id or K3_RINGACC_RING_ID_ANY for any general purpose ring * @flags: * @K3_RINGACC_RING_USE_PROXY: if set - proxy will be allocated and * used to access ring memory. Sopported only for rings in * Message/Credentials/Queue mode. * * Returns pointer on the Ring - struct k3_ring * or NULL in case of failure. */ struct k3_ring *k3_ringacc_request_ring(struct k3_ringacc *ringacc, int id, u32 flags); int k3_ringacc_request_rings_pair(struct k3_ringacc *ringacc, int fwd_id, int compl_id, struct k3_ring **fwd_ring, struct k3_ring **compl_ring); /** * k3_ringacc_ring_reset - ring reset * @ring: pointer on Ring * * Resets ring internal state ((hw)occ, (hw)idx). */ void k3_ringacc_ring_reset(struct k3_ring *ring); /** * k3_ringacc_ring_reset - ring reset for DMA rings * @ring: pointer on Ring * * Resets ring internal state ((hw)occ, (hw)idx). Should be used for rings * which are read by K3 UDMA, like TX or Free Host PD rings. */ void k3_ringacc_ring_reset_dma(struct k3_ring *ring, u32 occ); /** * k3_ringacc_ring_free - ring free * @ring: pointer on Ring * * Resets ring and free all alocated resources. */ int k3_ringacc_ring_free(struct k3_ring *ring); /** * k3_ringacc_get_ring_id - Get the Ring ID * @ring: pointer on ring * * Returns the Ring ID */ u32 k3_ringacc_get_ring_id(struct k3_ring *ring); /** * k3_ringacc_get_ring_irq_num - Get the irq number for the ring * @ring: pointer on ring * * Returns the interrupt number which can be used to request the interrupt */ int k3_ringacc_get_ring_irq_num(struct k3_ring *ring); /** * k3_ringacc_ring_cfg - ring configure * @ring: pointer on ring * @cfg: Ring configuration parameters (see &struct k3_ring_cfg) * * Configures ring, including ring memory allocation. * Returns 0 on success, errno otherwise. */ int k3_ringacc_ring_cfg(struct k3_ring *ring, struct k3_ring_cfg *cfg); /** * k3_ringacc_ring_get_size - get ring size * @ring: pointer on ring * * Returns ring size in number of elements. */ u32 k3_ringacc_ring_get_size(struct k3_ring *ring); /** * k3_ringacc_ring_get_free - get free elements * @ring: pointer on ring * * Returns number of free elements in the ring. */ u32 k3_ringacc_ring_get_free(struct k3_ring *ring); /** * k3_ringacc_ring_get_occ - get ring occupancy * @ring: pointer on ring * * Returns total number of valid entries on the ring */ u32 k3_ringacc_ring_get_occ(struct k3_ring *ring); /** * k3_ringacc_ring_is_full - checks if ring is full * @ring: pointer on ring * * Returns true if the ring is full */ u32 k3_ringacc_ring_is_full(struct k3_ring *ring); /** * k3_ringacc_ring_push - push element to the ring tail * @ring: pointer on ring * @elem: pointer on ring element buffer * * Push one ring element to the ring tail. Size of the ring element is * determined by ring configuration &struct k3_ring_cfg elm_size. * * Returns 0 on success, errno otherwise. */ int k3_ringacc_ring_push(struct k3_ring *ring, void *elem); /** * k3_ringacc_ring_pop - pop element from the ring head * @ring: pointer on ring * @elem: pointer on ring element buffer * * Push one ring element from the ring head. Size of the ring element is * determined by ring configuration &struct k3_ring_cfg elm_size.. * * Returns 0 on success, errno otherwise. */ int k3_ringacc_ring_pop(struct k3_ring *ring, void *elem); /** * k3_ringacc_ring_push_head - push element to the ring head * @ring: pointer on ring * @elem: pointer on ring element buffer * * Push one ring element to the ring head. Size of the ring element is * determined by ring configuration &struct k3_ring_cfg elm_size. * * Returns 0 on success, errno otherwise. * Not Supported by ring modes: K3_RINGACC_RING_MODE_RING */ int k3_ringacc_ring_push_head(struct k3_ring *ring, void *elem); /** * k3_ringacc_ring_pop_tail - pop element from the ring tail * @ring: pointer on ring * @elem: pointer on ring element buffer * * Push one ring element from the ring tail. Size of the ring element is * determined by ring configuration &struct k3_ring_cfg elm_size. * * Returns 0 on success, errno otherwise. * Not Supported by ring modes: K3_RINGACC_RING_MODE_RING */ int k3_ringacc_ring_pop_tail(struct k3_ring *ring, void *elem); u32 k3_ringacc_get_tisci_dev_id(struct k3_ring *ring); /* DMA ring support */ struct ti_sci_handle; /** * struct struct k3_ringacc_init_data - Initialization data for DMA rings */ struct k3_ringacc_init_data { const struct ti_sci_handle *tisci; u32 tisci_dev_id; u32 num_rings; }; struct k3_ringacc *k3_ringacc_dmarings_init(struct platform_device *pdev, struct k3_ringacc_init_data *data); #endif /* __SOC_TI_K3_RINGACC_API_H_ */

---

docroot: /var/www/469ed2f6-4d4b-4a8a-9f5e-ee4ef04d3bc8/public_html

---

curdir: /usr/src/linux-headers-6.8.0-117/include/linux/soc/ti

	.		4096
	..		4096
X	k3-ringacc.h		7912
X	knav_dma.h		5198
X	knav_qmss.h		2711
X	omap1-io.h		5005
X	omap1-mux.h		4848
X	omap1-soc.h		3900
X	omap1-usb.h		3810
X	ti-msgmgr.h		890
X	ti_sci_inta_msi.h		670
X	ti_sci_protocol.h		25133