/* SPDX-License-Identifier: GPL-2.0 */ /* * Copyright 2018-2020 Broadcom. */ #ifndef BCM_VK_H #define BCM_VK_H #include <linux/atomic.h> #include <linux/firmware.h> #include <linux/irq.h> #include <linux/kref.h> #include <linux/miscdevice.h> #include <linux/mutex.h> #include <linux/pci.h> #include <linux/poll.h> #include <linux/sched/signal.h> #include <linux/tty.h> #include <linux/uaccess.h> #include <uapi/linux/misc/bcm_vk.h> #include "bcm_vk_msg.h" #define DRV_MODULE_NAME … /* * Load Image is completed in two stages: * * 1) When the VK device boot-up, M7 CPU runs and executes the BootROM. * The Secure Boot Loader (SBL) as part of the BootROM will run * to open up ITCM for host to push BOOT1 image. * SBL will authenticate the image before jumping to BOOT1 image. * * 2) Because BOOT1 image is a secured image, we also called it the * Secure Boot Image (SBI). At second stage, SBI will initialize DDR * and wait for host to push BOOT2 image to DDR. * SBI will authenticate the image before jumping to BOOT2 image. * */ /* Location of registers of interest in BAR0 */ /* Request register for Secure Boot Loader (SBL) download */ #define BAR_CODEPUSH_SBL … /* Start of ITCM */ #define CODEPUSH_BOOT1_ENTRY … #define CODEPUSH_MASK … #define CODEPUSH_BOOTSTART … /* Boot Status register */ #define BAR_BOOT_STATUS … #define SRAM_OPEN … #define DDR_OPEN … /* Firmware loader progress status definitions */ #define FW_LOADER_ACK_SEND_MORE_DATA … #define FW_LOADER_ACK_IN_PROGRESS … #define FW_LOADER_ACK_RCVD_ALL_DATA … /* Boot1/2 is running in standalone mode */ #define BOOT_STDALONE_RUNNING … /* definitions for boot status register */ #define BOOT_STATE_MASK … #define BOOT_ERR_SHIFT … #define BOOT_ERR_MASK … #define BOOT_PROG_MASK … #define BROM_STATUS_NOT_RUN … #define BROM_NOT_RUN … #define BROM_STATUS_COMPLETE … #define BROM_RUNNING … #define BOOT1_STATUS_COMPLETE … #define BOOT1_RUNNING … #define BOOT2_STATUS_COMPLETE … #define BOOT2_RUNNING … /* Boot request for Secure Boot Image (SBI) */ #define BAR_CODEPUSH_SBI … /* 64M mapped to BAR2 */ #define CODEPUSH_BOOT2_ENTRY … #define BAR_CARD_STATUS … /* CARD_STATUS definitions */ #define CARD_STATUS_TTYVK0_READY … #define CARD_STATUS_TTYVK1_READY … #define BAR_BOOT1_STDALONE_PROGRESS … #define BOOT1_STDALONE_SUCCESS … #define BOOT1_STDALONE_PROGRESS_MASK … #define BAR_METADATA_VERSION … #define BAR_OS_UPTIME … #define BAR_CHIP_ID … #define MAJOR_SOC_REV(_chip_id) … #define BAR_CARD_TEMPERATURE … /* defines for all temperature sensor */ #define BCM_VK_TEMP_FIELD_MASK … #define BCM_VK_CPU_TEMP_SHIFT … #define BCM_VK_DDR0_TEMP_SHIFT … #define BCM_VK_DDR1_TEMP_SHIFT … #define BAR_CARD_VOLTAGE … /* defines for voltage rail conversion */ #define BCM_VK_VOLT_RAIL_MASK … #define BCM_VK_3P3_VOLT_REG_SHIFT … #define BAR_CARD_ERR_LOG … /* Error log register bit definition - register for error alerts */ #define ERR_LOG_UECC … #define ERR_LOG_SSIM_BUSY … #define ERR_LOG_AFBC_BUSY … #define ERR_LOG_HIGH_TEMP_ERR … #define ERR_LOG_WDOG_TIMEOUT … #define ERR_LOG_SYS_FAULT … #define ERR_LOG_RAMDUMP … #define ERR_LOG_COP_WDOG_TIMEOUT … /* warnings */ #define ERR_LOG_MEM_ALLOC_FAIL … #define ERR_LOG_LOW_TEMP_WARN … #define ERR_LOG_ECC … #define ERR_LOG_IPC_DWN … /* Alert bit definitions detectd on host */ #define ERR_LOG_HOST_INTF_V_FAIL … #define ERR_LOG_HOST_HB_FAIL … #define ERR_LOG_HOST_PCIE_DWN … #define BAR_CARD_ERR_MEM … /* defines for mem err, all fields have same width */ #define BCM_VK_MEM_ERR_FIELD_MASK … #define BCM_VK_ECC_MEM_ERR_SHIFT … #define BCM_VK_UECC_MEM_ERR_SHIFT … /* threshold of event occurrence and logs start to come out */ #define BCM_VK_ECC_THRESHOLD … #define BCM_VK_UECC_THRESHOLD … #define BAR_CARD_PWR_AND_THRE … /* defines for power and temp threshold, all fields have same width */ #define BCM_VK_PWR_AND_THRE_FIELD_MASK … #define BCM_VK_LOW_TEMP_THRE_SHIFT … #define BCM_VK_HIGH_TEMP_THRE_SHIFT … #define BCM_VK_PWR_STATE_SHIFT … #define BAR_CARD_STATIC_INFO … #define BAR_INTF_VER … #define BAR_INTF_VER_MAJOR_SHIFT … #define BAR_INTF_VER_MASK … /* * major and minor semantic version numbers supported * Please update as required on interface changes */ #define SEMANTIC_MAJOR … #define SEMANTIC_MINOR … /* * first door bell reg, ie for queue = 0. Only need the first one, as * we will use the queue number to derive the others */ #define VK_BAR0_REGSEG_DB_BASE … #define VK_BAR0_REGSEG_DB_REG_GAP … /* reset register and specific values */ #define VK_BAR0_RESET_DB_NUM … #define VK_BAR0_RESET_DB_SOFT … #define VK_BAR0_RESET_DB_HARD … #define VK_BAR0_RESET_RAMPDUMP … #define VK_BAR0_Q_DB_BASE(q_num) … #define VK_BAR0_RESET_DB_BASE … #define BAR_BOOTSRC_SELECT … /* BOOTSRC definitions */ #define BOOTSRC_SOFT_ENABLE … /* Card OS Firmware version size */ #define BAR_FIRMWARE_TAG_SIZE … #define FIRMWARE_STATUS_PRE_INIT_DONE … /* VK MSG_ID defines */ #define VK_MSG_ID_BITMAP_SIZE … #define VK_MSG_ID_BITMAP_MASK … #define VK_MSG_ID_OVERFLOW … /* * BAR1 */ /* BAR1 message q definition */ /* indicate if msgq ctrl in BAR1 is populated */ #define VK_BAR1_MSGQ_DEF_RDY … /* ready marker value for the above location, normal boot2 */ #define VK_BAR1_MSGQ_RDY_MARKER … /* ready marker value for the above location, normal boot2 */ #define VK_BAR1_DIAG_RDY_MARKER … /* number of msgqs in BAR1 */ #define VK_BAR1_MSGQ_NR … /* BAR1 queue control structure offset */ #define VK_BAR1_MSGQ_CTRL_OFF … /* BAR1 ucode and boot1 version tag */ #define VK_BAR1_UCODE_VER_TAG … #define VK_BAR1_BOOT1_VER_TAG … #define VK_BAR1_VER_TAG_SIZE … /* Memory to hold the DMA buffer memory address allocated for boot2 download */ #define VK_BAR1_DMA_BUF_OFF_HI … #define VK_BAR1_DMA_BUF_OFF_LO … #define VK_BAR1_DMA_BUF_SZ … /* Scratch memory allocated on host for VK */ #define VK_BAR1_SCRATCH_OFF_HI … #define VK_BAR1_SCRATCH_OFF_LO … #define VK_BAR1_SCRATCH_SZ_ADDR … #define VK_BAR1_SCRATCH_DEF_NR_PAGES … /* BAR1 DAUTH info */ #define VK_BAR1_DAUTH_BASE_ADDR … #define VK_BAR1_DAUTH_STORE_SIZE … #define VK_BAR1_DAUTH_VALID_SIZE … #define VK_BAR1_DAUTH_MAX … #define VK_BAR1_DAUTH_STORE_ADDR(x) … #define VK_BAR1_DAUTH_VALID_ADDR(x) … /* BAR1 SOTP AUTH and REVID info */ #define VK_BAR1_SOTP_REVID_BASE_ADDR … #define VK_BAR1_SOTP_REVID_SIZE … #define VK_BAR1_SOTP_REVID_MAX … #define VK_BAR1_SOTP_REVID_ADDR(x) … /* VK device supports a maximum of 3 bars */ #define MAX_BAR … /* default number of msg blk for inband SGL */ #define BCM_VK_DEF_IB_SGL_BLK_LEN … #define BCM_VK_IB_SGL_BLK_MAX … enum pci_barno { … }; #ifdef CONFIG_BCM_VK_TTY #define BCM_VK_NUM_TTY … #else #define BCM_VK_NUM_TTY … #endif struct bcm_vk_tty { … }; /* VK device max power state, supports 3, full, reduced and low */ #define MAX_OPP … #define MAX_CARD_INFO_TAG_SIZE … struct bcm_vk_card_info { … }; /* DAUTH related info */ struct bcm_vk_dauth_key { … }; struct bcm_vk_dauth_info { … }; /* * Control structure of logging messages from the card. This * buffer is for logmsg that comes from vk */ struct bcm_vk_peer_log { … }; /* max buf size allowed */ #define BCM_VK_PEER_LOG_BUF_MAX … /* max size per line of peer log */ #define BCM_VK_PEER_LOG_LINE_MAX … /* * single entry for processing type + utilization */ #define BCM_VK_PROC_TYPE_TAG_LEN … struct bcm_vk_proc_mon_entry_t { … }; /** * Structure for run time utilization */ #define BCM_VK_PROC_MON_MAX … struct bcm_vk_proc_mon_info { … }; struct bcm_vk_hb_ctrl { … }; struct bcm_vk_alert { … }; /* some alert counters that the driver will keep track */ struct bcm_vk_alert_cnts { … }; struct bcm_vk { … }; /* wq offload work items bits definitions */ enum bcm_vk_wq_offload_flags { … }; /* a macro to get an individual field with mask and shift */ #define BCM_VK_EXTRACT_FIELD(_field, _reg, _mask, _shift) … struct bcm_vk_entry { … }; /* alerts that could be generated from peer */ #define BCM_VK_PEER_ERR_NUM … extern struct bcm_vk_entry const bcm_vk_peer_err[BCM_VK_PEER_ERR_NUM]; /* alerts detected by the host */ #define BCM_VK_HOST_ERR_NUM … extern struct bcm_vk_entry const bcm_vk_host_err[BCM_VK_HOST_ERR_NUM]; /* * check if PCIe interface is down on read. Use it when it is * certain that _val should never be all ones. */ #define BCM_VK_INTF_IS_DOWN(val) … static inline u32 vkread32(struct bcm_vk *vk, enum pci_barno bar, u64 offset) { … } static inline void vkwrite32(struct bcm_vk *vk, u32 value, enum pci_barno bar, u64 offset) { … } static inline u8 vkread8(struct bcm_vk *vk, enum pci_barno bar, u64 offset) { … } static inline void vkwrite8(struct bcm_vk *vk, u8 value, enum pci_barno bar, u64 offset) { … } static inline bool bcm_vk_msgq_marker_valid(struct bcm_vk *vk) { … } int bcm_vk_open(struct inode *inode, struct file *p_file); ssize_t bcm_vk_read(struct file *p_file, char __user *buf, size_t count, loff_t *f_pos); ssize_t bcm_vk_write(struct file *p_file, const char __user *buf, size_t count, loff_t *f_pos); __poll_t bcm_vk_poll(struct file *p_file, struct poll_table_struct *wait); int bcm_vk_release(struct inode *inode, struct file *p_file); void bcm_vk_release_data(struct kref *kref); irqreturn_t bcm_vk_msgq_irqhandler(int irq, void *dev_id); irqreturn_t bcm_vk_notf_irqhandler(int irq, void *dev_id); irqreturn_t bcm_vk_tty_irqhandler(int irq, void *dev_id); int bcm_vk_msg_init(struct bcm_vk *vk); void bcm_vk_msg_remove(struct bcm_vk *vk); void bcm_vk_drain_msg_on_reset(struct bcm_vk *vk); int bcm_vk_sync_msgq(struct bcm_vk *vk, bool force_sync); void bcm_vk_blk_drv_access(struct bcm_vk *vk); s32 bcm_to_h_msg_dequeue(struct bcm_vk *vk); int bcm_vk_send_shutdown_msg(struct bcm_vk *vk, u32 shut_type, const pid_t pid, const u32 q_num); void bcm_to_v_q_doorbell(struct bcm_vk *vk, u32 q_num, u32 db_val); int bcm_vk_auto_load_all_images(struct bcm_vk *vk); void bcm_vk_hb_init(struct bcm_vk *vk); void bcm_vk_hb_deinit(struct bcm_vk *vk); void bcm_vk_handle_notf(struct bcm_vk *vk); bool bcm_vk_drv_access_ok(struct bcm_vk *vk); void bcm_vk_set_host_alert(struct bcm_vk *vk, u32 bit_mask); #ifdef CONFIG_BCM_VK_TTY int bcm_vk_tty_init(struct bcm_vk *vk, char *name); void bcm_vk_tty_exit(struct bcm_vk *vk); void bcm_vk_tty_terminate_tty_user(struct bcm_vk *vk); void bcm_vk_tty_wq_exit(struct bcm_vk *vk); static inline void bcm_vk_tty_set_irq_enabled(struct bcm_vk *vk, int index) { … } #else static inline int bcm_vk_tty_init(struct bcm_vk *vk, char *name) { return 0; } static inline void bcm_vk_tty_exit(struct bcm_vk *vk) { } static inline void bcm_vk_tty_terminate_tty_user(struct bcm_vk *vk) { } static inline void bcm_vk_tty_wq_exit(struct bcm_vk *vk) { } static inline void bcm_vk_tty_set_irq_enabled(struct bcm_vk *vk, int index) { } #endif /* CONFIG_BCM_VK_TTY */ #endif
Codebase Browser
linux