SOC: TI Keystone Ring Accelerator driver
The Ring Accelerator (RINGACC or RA) provides hardware acceleration to enable straightforward passing of work between a producer and a consumer. There is one RINGACC module per NAVSS on TI AM65x SoCs. -----BEGIN PGP SIGNATURE----- Version: GnuPG v1 iQIcBAABAgAGBQJeH1VYAAoJEHJsHOdBp5c/k4cP/RHrk67mB8L6JC7G9H1XWedM w4aG80q7u8dAydk9k3wJM1Y4ChXfflR3JYc5KBghrsQiRPF8myh4JEwi3+8jpTT5 LUOJifaEtR79VuNCHyG9Wgni3LWYnp7HmG4jM1bzcDwLgpf4I8cBwXkCfW0kmyPq HAaFLWo1net3TkhSnUkbFUn54vESl569/D6FIfFFK2DPJH/gLUKQ6W8Xnd1uKBaI 9RpnN6eGA0ZWZkZG+Xu7XA/VfC/AR+wxbCr0l1jHB9+4CrngOEwsTnP1SFxFsD1v L7zAT5JguNg13jbELVgTpUX8X5/XBfbOzIrNZpeXnl0fl8p2SU25n8hw8KdYjKCP 5puO6wye5NnliQs5hLlMTydF77VazAqdBhLz5i1OMa+cuA1zVzm7dyIZBAWbI8IC TY86h9eGyGKELjljrYhW8ijARbzu/J3SpO3cSklvL/BfXtlVYen5d0mZxsKBDWOi bni1yV37b65IWjkimwzkaVq/sN9jWTAF2a192SkKeEBqnms5jxKDeCRq9qSxpCWv ONFROd6WXImDTk/MLgo4EdAq+ProoBFR+YDLModSAv3fZaBFUgi5mU5Xnx1+cAFq SL9TguzvXhUv6o6ywNZSsSM/7I2iB5uOMRKjCeGg2x1JN9lyOMzrVlJ8JzzUyKV3 iiKDJjNdZD0/Rn2fl5a1 =m1rI -----END PGP SIGNATURE----- Merge tag 'drivers_soc_for_5.6' of git://git.kernel.org/pub/scm/linux/kernel/git/ssantosh/linux-keystone into arm/drivers SOC: TI Keystone Ring Accelerator driver The Ring Accelerator (RINGACC or RA) provides hardware acceleration to enable straightforward passing of work between a producer and a consumer. There is one RINGACC module per NAVSS on TI AM65x SoCs. * tag 'drivers_soc_for_5.6' of git://git.kernel.org/pub/scm/linux/kernel/git/ssantosh/linux-keystone: soc: ti: k3: add navss ringacc driver bindings: soc: ti: add documentation for k3 ringacc Link: https://lore.kernel.org/r/1579205259-4845-1-git-send-email-santosh.shilimkar@oracle.com Signed-off-by: Olof Johansson <olof@lixom.net>
This commit is contained in:
Olof Johansson
commit
2ced5a3449
|
|
@ -0,0 +1,59 @@
|
|||
* Texas Instruments K3 NavigatorSS Ring Accelerator
|
||||
|
||||
The Ring Accelerator (RA) is a machine which converts read/write accesses
|
||||
from/to a constant address into corresponding read/write accesses from/to a
|
||||
circular data structure in memory. The RA eliminates the need for each DMA
|
||||
controller which needs to access ring elements from having to know the current
|
||||
state of the ring (base address, current offset). The DMA controller
|
||||
performs a read or write access to a specific address range (which maps to the
|
||||
source interface on the RA) and the RA replaces the address for the transaction
|
||||
with a new address which corresponds to the head or tail element of the ring
|
||||
(head for reads, tail for writes).
|
||||
|
||||
The Ring Accelerator is a hardware module that is responsible for accelerating
|
||||
management of the packet queues. The K3 SoCs can have more than one RA instances
|
||||
|
||||
Required properties:
|
||||
- compatible : Must be "ti,am654-navss-ringacc";
|
||||
- reg : Should contain register location and length of the following
|
||||
named register regions.
|
||||
- reg-names : should be
|
||||
"rt" - The RA Ring Real-time Control/Status Registers
|
||||
"fifos" - The RA Queues Registers
|
||||
"proxy_gcfg" - The RA Proxy Global Config Registers
|
||||
"proxy_target" - The RA Proxy Datapath Registers
|
||||
- ti,num-rings : Number of rings supported by RA
|
||||
- ti,sci-rm-range-gp-rings : TI-SCI RM subtype for GP ring range
|
||||
- ti,sci : phandle on TI-SCI compatible System controller node
|
||||
- ti,sci-dev-id : TI-SCI device id of the ring accelerator
|
||||
- msi-parent : phandle for "ti,sci-inta" interrupt controller
|
||||
|
||||
Optional properties:
|
||||
-- ti,dma-ring-reset-quirk : enable ringacc / udma ring state interoperability
|
||||
issue software w/a
|
||||
|
||||
Example:
|
||||
|
||||
ringacc: ringacc@3c000000 {
|
||||
compatible = "ti,am654-navss-ringacc";
|
||||
reg = <0x0 0x3c000000 0x0 0x400000>,
|
||||
<0x0 0x38000000 0x0 0x400000>,
|
||||
<0x0 0x31120000 0x0 0x100>,
|
||||
<0x0 0x33000000 0x0 0x40000>;
|
||||
reg-names = "rt", "fifos",
|
||||
"proxy_gcfg", "proxy_target";
|
||||
ti,num-rings = <818>;
|
||||
ti,sci-rm-range-gp-rings = <0x2>; /* GP ring range */
|
||||
ti,dma-ring-reset-quirk;
|
||||
ti,sci = <&dmsc>;
|
||||
ti,sci-dev-id = <187>;
|
||||
msi-parent = <&inta_main_udmass>;
|
||||
};
|
||||
|
||||
client:
|
||||
|
||||
dma_ipx: dma_ipx@<addr> {
|
||||
...
|
||||
ti,ringacc = <&ringacc>;
|
||||
...
|
||||
}
|
||||
|
|
@ -80,6 +80,17 @@ config TI_SCI_PM_DOMAINS
|
|||
called ti_sci_pm_domains. Note this is needed early in boot before
|
||||
rootfs may be available.
|
||||
|
||||
config TI_K3_RINGACC
|
||||
bool "K3 Ring accelerator Sub System"
|
||||
depends on ARCH_K3 || COMPILE_TEST
|
||||
depends on TI_SCI_INTA_IRQCHIP
|
||||
help
|
||||
Say y here to support the K3 Ring accelerator module.
|
||||
The Ring Accelerator (RINGACC or RA) provides hardware acceleration
|
||||
to enable straightforward passing of work between a producer
|
||||
and a consumer. There is one RINGACC module per NAVSS on TI AM65x SoCs
|
||||
If unsure, say N.
|
||||
|
||||
endif # SOC_TI
|
||||
|
||||
config TI_SCI_INTA_MSI_DOMAIN
|
||||
|
|
|
|||
|
|
@ -10,3 +10,4 @@ obj-$(CONFIG_ARCH_OMAP2PLUS) += omap_prm.o
|
|||
obj-$(CONFIG_WKUP_M3_IPC) += wkup_m3_ipc.o
|
||||
obj-$(CONFIG_TI_SCI_PM_DOMAINS) += ti_sci_pm_domains.o
|
||||
obj-$(CONFIG_TI_SCI_INTA_MSI_DOMAIN) += ti_sci_inta_msi.o
|
||||
obj-$(CONFIG_TI_K3_RINGACC) += k3-ringacc.o
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,244 @@
|
|||
/* SPDX-License-Identifier: GPL-2.0 */
|
||||
/*
|
||||
* K3 Ring Accelerator (RA) subsystem interface
|
||||
*
|
||||
* Copyright (C) 2019 Texas Instruments Incorporated - http://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
|
||||
*/
|
||||
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;
|
||||
};
|
||||
|
||||
#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);
|
||||
|
||||
/**
|
||||
* 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);
|
||||
|
||||
#endif /* __SOC_TI_K3_RINGACC_API_H_ */
|
||||
Loading…
Reference in New Issue