amdkfd: Add queue module

The queue module enables allocating and initializing queues uniformly.

v3: Removed typedef and redundant memset call. Broke long pr_debug print to one
liners and Added documentation.

v5: Move amdkfd from drm/radeon/ to drm/amd/

Signed-off-by: Ben Goz <ben.goz@amd.com>
Signed-off-by: Oded Gabbay <oded.gabbay@amd.com>

3 files changed, 209 insertions, 2 deletions

diff --git a/drivers/gpu/drm/amd/amdkfd/Makefile b/drivers/gpu/drm/amd/amdkfd/Makefile
index e829a3fa7d8e..42df022a0912 100644
--- a/drivers/gpu/drm/amd/amdkfd/Makefile
+++ b/drivers/gpu/drm/amd/amdkfd/Makefile
@@ -6,6 +6,6 @@ ccflags-y := -Iinclude/drm -Idrivers/gpu/drm/amd/include/
 
 amdkfd-y        := kfd_module.o kfd_device.o kfd_chardev.o kfd_topology.o \
                 kfd_pasid.o kfd_doorbell.o kfd_flat_memory.o \
-                kfd_process.o
+                kfd_process.o kfd_queue.o
 
 obj-$(CONFIG_HSA_AMD)   += amdkfd.o
diff --git a/drivers/gpu/drm/amd/amdkfd/kfd_priv.h b/drivers/gpu/drm/amd/amdkfd/kfd_priv.h
index 431a09bbab62..5f6f13d1a20d 100644
--- a/drivers/gpu/drm/amd/amdkfd/kfd_priv.h
+++ b/drivers/gpu/drm/amd/amdkfd/kfd_priv.h
@@ -57,7 +57,6 @@ extern int max_num_of_queues_per_process;
 #define KFD_MAX_NUM_OF_QUEUES_PER_PROCESS_DEFAULT 128
 #define KFD_MAX_NUM_OF_QUEUES_PER_PROCESS 1024
 
-
 struct kfd_device_info {
         unsigned int max_pasid_bits;
         size_t ih_ring_entry_size;
@@ -120,6 +119,129 @@ void kfd_chardev_exit(void);
 struct device *kfd_chardev(void);
 
 
+/**
+ * enum kfd_queue_type
+ *
+ * @KFD_QUEUE_TYPE_COMPUTE: Regular user mode queue type.
+ *
+ * @KFD_QUEUE_TYPE_SDMA: Sdma user mode queue type.
+ *
+ * @KFD_QUEUE_TYPE_HIQ: HIQ queue type.
+ *
+ * @KFD_QUEUE_TYPE_DIQ: DIQ queue type.
+ */
+enum kfd_queue_type  {
+        KFD_QUEUE_TYPE_COMPUTE,
+        KFD_QUEUE_TYPE_SDMA,
+        KFD_QUEUE_TYPE_HIQ,
+        KFD_QUEUE_TYPE_DIQ
+};
+
+/**
+ * struct queue_properties
+ *
+ * @type: The queue type.
+ *
+ * @queue_id: Queue identifier.
+ *
+ * @queue_address: Queue ring buffer address.
+ *
+ * @queue_size: Queue ring buffer size.
+ *
+ * @priority: Defines the queue priority relative to other queues in the
+ * process.
+ * This is just an indication and HW scheduling may override the priority as
+ * necessary while keeping the relative prioritization.
+ * the priority granularity is from 0 to f which f is the highest priority.
+ * currently all queues are initialized with the highest priority.
+ *
+ * @queue_percent: This field is partially implemented and currently a zero in
+ * this field defines that the queue is non active.
+ *
+ * @read_ptr: User space address which points to the number of dwords the
+ * cp read from the ring buffer. This field updates automatically by the H/W.
+ *
+ * @write_ptr: Defines the number of dwords written to the ring buffer.
+ *
+ * @doorbell_ptr: This field aim is to notify the H/W of new packet written to
+ * the queue ring buffer. This field should be similar to write_ptr and the user
+ * should update this field after he updated the write_ptr.
+ *
+ * @doorbell_off: The doorbell offset in the doorbell pci-bar.
+ *
+ * @is_interop: Defines if this is a interop queue. Interop queue means that the
+ * queue can access both graphics and compute resources.
+ *
+ * @is_active: Defines if the queue is active or not.
+ *
+ * @vmid: If the scheduling mode is no cp scheduling the field defines the vmid
+ * of the queue.
+ *
+ * This structure represents the queue properties for each queue no matter if
+ * it's user mode or kernel mode queue.
+ *
+ */
+struct queue_properties {
+        enum kfd_queue_type type;
+        unsigned int queue_id;
+        uint64_t queue_address;
+        uint64_t  queue_size;
+        uint32_t priority;
+        uint32_t queue_percent;
+        uint32_t *read_ptr;
+        uint32_t *write_ptr;
+        uint32_t *doorbell_ptr;
+        uint32_t doorbell_off;
+        bool is_interop;
+        bool is_active;
+        /* Not relevant for user mode queues in cp scheduling */
+        unsigned int vmid;
+};
+
+/**
+ * struct queue
+ *
+ * @list: Queue linked list.
+ *
+ * @mqd: The queue MQD.
+ *
+ * @mqd_mem_obj: The MQD local gpu memory object.
+ *
+ * @gart_mqd_addr: The MQD gart mc address.
+ *
+ * @properties: The queue properties.
+ *
+ * @mec: Used only in no cp scheduling mode and identifies to micro engine id
+ * that the queue should be execute on.
+ *
+ * @pipe: Used only in no cp scheduling mode and identifies the queue's pipe id.
+ *
+ * @queue: Used only in no cp scheduliong mode and identifies the queue's slot.
+ *
+ * @process: The kfd process that created this queue.
+ *
+ * @device: The kfd device that created this queue.
+ *
+ * This structure represents user mode compute queues.
+ * It contains all the necessary data to handle such queues.
+ *
+ */
+
+struct queue {
+        struct list_head list;
+        void *mqd;
+        struct kfd_mem_obj *mqd_mem_obj;
+        uint64_t gart_mqd_addr;
+        struct queue_properties properties;
+
+        uint32_t mec;
+        uint32_t pipe;
+        uint32_t queue;
+
+        struct kfd_process      *process;
+        struct kfd_dev          *device;
+};
+
 /* Data that is per-process-per device. */
 struct kfd_process_device {
         /*
diff --git a/drivers/gpu/drm/amd/amdkfd/kfd_queue.c b/drivers/gpu/drm/amd/amdkfd/kfd_queue.c
new file mode 100644
index 000000000000..9a0c90b0702e
--- /dev/null
+++ b/drivers/gpu/drm/amd/amdkfd/kfd_queue.c
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2014 Advanced Micro Devices, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+
+#include <linux/slab.h>
+#include "kfd_priv.h"
+
+void print_queue_properties(struct queue_properties *q)
+{
+        if (!q)
+                return;
+
+        pr_debug("Printing queue properties:\n");
+        pr_debug("Queue Type: %u\n", q->type);
+        pr_debug("Queue Size: %llu\n", q->queue_size);
+        pr_debug("Queue percent: %u\n", q->queue_percent);
+        pr_debug("Queue Address: 0x%llX\n", q->queue_address);
+        pr_debug("Queue Id: %u\n", q->queue_id);
+        pr_debug("Queue Process Vmid: %u\n", q->vmid);
+        pr_debug("Queue Read Pointer: 0x%p\n", q->read_ptr);
+        pr_debug("Queue Write Pointer: 0x%p\n", q->write_ptr);
+        pr_debug("Queue Doorbell Pointer: 0x%p\n", q->doorbell_ptr);
+        pr_debug("Queue Doorbell Offset: %u\n", q->doorbell_off);
+}
+
+void print_queue(struct queue *q)
+{
+        if (!q)
+                return;
+        pr_debug("Printing queue:\n");
+        pr_debug("Queue Type: %u\n", q->properties.type);
+        pr_debug("Queue Size: %llu\n", q->properties.queue_size);
+        pr_debug("Queue percent: %u\n", q->properties.queue_percent);
+        pr_debug("Queue Address: 0x%llX\n", q->properties.queue_address);
+        pr_debug("Queue Id: %u\n", q->properties.queue_id);
+        pr_debug("Queue Process Vmid: %u\n", q->properties.vmid);
+        pr_debug("Queue Read Pointer: 0x%p\n", q->properties.read_ptr);
+        pr_debug("Queue Write Pointer: 0x%p\n", q->properties.write_ptr);
+        pr_debug("Queue Doorbell Pointer: 0x%p\n", q->properties.doorbell_ptr);
+        pr_debug("Queue Doorbell Offset: %u\n", q->properties.doorbell_off);
+        pr_debug("Queue MQD Address: 0x%p\n", q->mqd);
+        pr_debug("Queue MQD Gart: 0x%llX\n", q->gart_mqd_addr);
+        pr_debug("Queue Process Address: 0x%p\n", q->process);
+        pr_debug("Queue Device Address: 0x%p\n", q->device);
+}
+
+int init_queue(struct queue **q, struct queue_properties properties)
+{
+        struct queue *tmp;
+
+        BUG_ON(!q);
+
+        tmp = kzalloc(sizeof(struct queue), GFP_KERNEL);
+        if (!tmp)
+                return -ENOMEM;
+
+        memcpy(&tmp->properties, &properties, sizeof(struct queue_properties));
+
+        *q = tmp;
+        return 0;
+}
+
+void uninit_queue(struct queue *q)
+{
+        kfree(q);
+}