Add user space api for bcm-vk driver.
Signed-off-by: Scott Branden <[email protected]>
---
include/uapi/linux/misc/bcm_vk.h | 99 ++++++++++++++++++++++++++++++++
1 file changed, 99 insertions(+)
create mode 100644 include/uapi/linux/misc/bcm_vk.h
diff --git a/include/uapi/linux/misc/bcm_vk.h b/include/uapi/linux/misc/bcm_vk.h
new file mode 100644
index 000000000000..da7848e7c438
--- /dev/null
+++ b/include/uapi/linux/misc/bcm_vk.h
@@ -0,0 +1,99 @@
+/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
+/*
+ * Copyright 2018-2020 Broadcom.
+ */
+
+#ifndef __UAPI_LINUX_MISC_BCM_VK_H
+#define __UAPI_LINUX_MISC_BCM_VK_H
+
+#include <linux/ioctl.h>
+#include <linux/types.h>
+
+#define BCM_VK_MAX_FILENAME 64
+
+struct vk_image {
+ __u32 type; /* Type of image */
+#define VK_IMAGE_TYPE_BOOT1 1 /* 1st stage (load to SRAM) */
+#define VK_IMAGE_TYPE_BOOT2 2 /* 2nd stage (load to DDR) */
+ char filename[BCM_VK_MAX_FILENAME]; /* Filename of image */
+};
+
+struct vk_reset {
+ __u32 arg1;
+ __u32 arg2;
+};
+
+#define VK_MAGIC 0x5e
+
+/* Load image to Valkyrie */
+#define VK_IOCTL_LOAD_IMAGE _IOW(VK_MAGIC, 0x2, struct vk_image)
+
+/* Send Reset to Valkyrie */
+#define VK_IOCTL_RESET _IOW(VK_MAGIC, 0x4, struct vk_reset)
+
+/*
+ * message block - basic unit in the message where a message's size is always
+ * N x sizeof(basic_block)
+ */
+struct vk_msg_blk {
+ __u8 function_id;
+#define VK_FID_TRANS_BUF 5
+#define VK_FID_SHUTDOWN 8
+ __u8 size;
+ __u16 trans_id; /* transport id, queue & msg_id */
+ __u32 context_id;
+ __u32 args[2];
+#define VK_CMD_PLANES_MASK 0x000f /* number of planes to up/download */
+#define VK_CMD_UPLOAD 0x0400 /* memory transfer to vk */
+#define VK_CMD_DOWNLOAD 0x0500 /* memory transfer from vk */
+#define VK_CMD_MASK 0x0f00 /* command mask */
+};
+
+#define VK_BAR_FWSTS 0x41c
+#define VK_BAR_COP_FWSTS 0x428
+/* VK_FWSTS definitions */
+#define VK_FWSTS_RELOCATION_ENTRY (1ULL << 0)
+#define VK_FWSTS_RELOCATION_EXIT (1ULL << 1)
+#define VK_FWSTS_INIT_START (1ULL << 2)
+#define VK_FWSTS_ARCH_INIT_DONE (1ULL << 3)
+#define VK_FWSTS_PRE_KNL1_INIT_DONE (1ULL << 4)
+#define VK_FWSTS_PRE_KNL2_INIT_DONE (1ULL << 5)
+#define VK_FWSTS_POST_KNL_INIT_DONE (1ULL << 6)
+#define VK_FWSTS_INIT_DONE (1ULL << 7)
+#define VK_FWSTS_APP_INIT_START (1ULL << 8)
+#define VK_FWSTS_APP_INIT_DONE (1ULL << 9)
+#define VK_FWSTS_MASK 0xffffffff
+#define VK_FWSTS_READY (VK_FWSTS_INIT_START | \
+ VK_FWSTS_ARCH_INIT_DONE | \
+ VK_FWSTS_PRE_KNL1_INIT_DONE | \
+ VK_FWSTS_PRE_KNL2_INIT_DONE | \
+ VK_FWSTS_POST_KNL_INIT_DONE | \
+ VK_FWSTS_INIT_DONE | \
+ VK_FWSTS_APP_INIT_START | \
+ VK_FWSTS_APP_INIT_DONE)
+/* Deinit */
+#define VK_FWSTS_APP_DEINIT_START (1ULL << 23)
+#define VK_FWSTS_APP_DEINIT_DONE (1ULL << 24)
+#define VK_FWSTS_DRV_DEINIT_START (1ULL << 25)
+#define VK_FWSTS_DRV_DEINIT_DONE (1ULL << 26)
+#define VK_FWSTS_RESET_DONE (1ULL << 27)
+#define VK_FWSTS_DEINIT_TRIGGERED (VK_FWSTS_APP_DEINIT_START | \
+ VK_FWSTS_APP_DEINIT_DONE | \
+ VK_FWSTS_DRV_DEINIT_START | \
+ VK_FWSTS_DRV_DEINIT_DONE)
+/* Last nibble for reboot reason */
+#define VK_FWSTS_RESET_REASON_SHIFT 28
+#define VK_FWSTS_RESET_REASON_MASK (0xf << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_SYS_PWRUP (0x0 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_MBOX_DB (0x1 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_M7_WDOG (0x2 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_TEMP (0x3 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_PCI_FLR (0x4 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_PCI_HOT (0x5 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_PCI_WARM (0x6 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_PCI_COLD (0x7 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_L1 (0x8 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_L0 (0x9 << VK_FWSTS_RESET_REASON_SHIFT)
+#define VK_FWSTS_RESET_UNKNOWN (0xf << VK_FWSTS_RESET_REASON_SHIFT)
+
+#endif /* __UAPI_LINUX_MISC_BCM_VK_H */
--
2.17.1
On Tue, Aug 25, 2020 at 12:43:58PM -0700, Scott Branden wrote:
> Add user space api for bcm-vk driver.
>
> Signed-off-by: Scott Branden <[email protected]>
> ---
> include/uapi/linux/misc/bcm_vk.h | 99 ++++++++++++++++++++++++++++++++
> 1 file changed, 99 insertions(+)
> create mode 100644 include/uapi/linux/misc/bcm_vk.h
>
> diff --git a/include/uapi/linux/misc/bcm_vk.h b/include/uapi/linux/misc/bcm_vk.h
> new file mode 100644
> index 000000000000..da7848e7c438
> --- /dev/null
> +++ b/include/uapi/linux/misc/bcm_vk.h
> @@ -0,0 +1,99 @@
> +/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
> +/*
> + * Copyright 2018-2020 Broadcom.
> + */
> +
> +#ifndef __UAPI_LINUX_MISC_BCM_VK_H
> +#define __UAPI_LINUX_MISC_BCM_VK_H
> +
> +#include <linux/ioctl.h>
> +#include <linux/types.h>
> +
> +#define BCM_VK_MAX_FILENAME 64
> +
> +struct vk_image {
> + __u32 type; /* Type of image */
> +#define VK_IMAGE_TYPE_BOOT1 1 /* 1st stage (load to SRAM) */
> +#define VK_IMAGE_TYPE_BOOT2 2 /* 2nd stage (load to DDR) */
> + char filename[BCM_VK_MAX_FILENAME]; /* Filename of image */
nit, but this should really be __u8 filename[...
right?
> +};
> +
> +struct vk_reset {
> + __u32 arg1;
> + __u32 arg2;
> +};
> +
> +#define VK_MAGIC 0x5e
> +
> +/* Load image to Valkyrie */
> +#define VK_IOCTL_LOAD_IMAGE _IOW(VK_MAGIC, 0x2, struct vk_image)
> +
> +/* Send Reset to Valkyrie */
> +#define VK_IOCTL_RESET _IOW(VK_MAGIC, 0x4, struct vk_reset)
> +
> +/*
> + * message block - basic unit in the message where a message's size is always
> + * N x sizeof(basic_block)
> + */
> +struct vk_msg_blk {
> + __u8 function_id;
> +#define VK_FID_TRANS_BUF 5
> +#define VK_FID_SHUTDOWN 8
> + __u8 size;
Size of what?
> + __u16 trans_id; /* transport id, queue & msg_id */
> + __u32 context_id;
> + __u32 args[2];
> +#define VK_CMD_PLANES_MASK 0x000f /* number of planes to up/download */
> +#define VK_CMD_UPLOAD 0x0400 /* memory transfer to vk */
> +#define VK_CMD_DOWNLOAD 0x0500 /* memory transfer from vk */
> +#define VK_CMD_MASK 0x0f00 /* command mask */
> +};
What are these defines for? The args? Something else? It's not really
obvious here...
thanks,
greg k-h
Hi Greg,
On 2020-09-07 5:35 a.m., Greg Kroah-Hartman wrote:
> On Tue, Aug 25, 2020 at 12:43:58PM -0700, Scott Branden wrote:
>> Add user space api for bcm-vk driver.
>>
>> Signed-off-by: Scott Branden <[email protected]>
>> ---
>> include/uapi/linux/misc/bcm_vk.h | 99 ++++++++++++++++++++++++++++++++
>> 1 file changed, 99 insertions(+)
>> create mode 100644 include/uapi/linux/misc/bcm_vk.h
>>
>> diff --git a/include/uapi/linux/misc/bcm_vk.h b/include/uapi/linux/misc/bcm_vk.h
>> new file mode 100644
>> index 000000000000..da7848e7c438
>> --- /dev/null
>> +++ b/include/uapi/linux/misc/bcm_vk.h
>> @@ -0,0 +1,99 @@
>> +/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
>> +/*
>> + * Copyright 2018-2020 Broadcom.
>> + */
>> +
>> +#ifndef __UAPI_LINUX_MISC_BCM_VK_H
>> +#define __UAPI_LINUX_MISC_BCM_VK_H
>> +
>> +#include <linux/ioctl.h>
>> +#include <linux/types.h>
>> +
>> +#define BCM_VK_MAX_FILENAME 64
>> +
>> +struct vk_image {
>> + __u32 type; /* Type of image */
>> +#define VK_IMAGE_TYPE_BOOT1 1 /* 1st stage (load to SRAM) */
>> +#define VK_IMAGE_TYPE_BOOT2 2 /* 2nd stage (load to DDR) */
>> + char filename[BCM_VK_MAX_FILENAME]; /* Filename of image */
> nit, but this should really be __u8 filename[...
> right?
Changed to __u8. Thanks.
>
>
>
>> +};
>> +
>> +struct vk_reset {
>> + __u32 arg1;
>> + __u32 arg2;
>> +};
>> +
>> +#define VK_MAGIC 0x5e
>> +
>> +/* Load image to Valkyrie */
>> +#define VK_IOCTL_LOAD_IMAGE _IOW(VK_MAGIC, 0x2, struct vk_image)
>> +
>> +/* Send Reset to Valkyrie */
>> +#define VK_IOCTL_RESET _IOW(VK_MAGIC, 0x4, struct vk_reset)
>> +
>> +/*
>> + * message block - basic unit in the message where a message's size is always
>> + * N x sizeof(basic_block)
>> + */
>> +struct vk_msg_blk {
>> + __u8 function_id;
>> +#define VK_FID_TRANS_BUF 5
>> +#define VK_FID_SHUTDOWN 8
>> + __u8 size;
> Size of what?
Size is number of vk_msg_blk's. Comment is above the struct.
Can add a comment on this line as well.
>
>> + __u16 trans_id; /* transport id, queue & msg_id */
>> + __u32 context_id;
>> + __u32 args[2];
>> +#define VK_CMD_PLANES_MASK 0x000f /* number of planes to up/download */
>> +#define VK_CMD_UPLOAD 0x0400 /* memory transfer to vk */
>> +#define VK_CMD_DOWNLOAD 0x0500 /* memory transfer from vk */
>> +#define VK_CMD_MASK 0x0f00 /* command mask */
>> +};
> What are these defines for? The args? Something else? It's not really
> obvious here...
Agree, it's not really obvious and is confusing.
When args[0] is a command the defines apply.
Will add comments.
>
> thanks,
>
> greg k-h