| Shad Ansari | 2f7f9be | 2017-06-07 13:34:53 -0700 | [diff] [blame] | 1 | /* |
| 2 | <:copyright-BRCM:2016:DUAL/GPL:standard |
| 3 | |
| 4 | Broadcom Proprietary and Confidential.(c) 2016 Broadcom |
| 5 | All Rights Reserved |
| 6 | |
| 7 | Unless you and Broadcom execute a separate written software license |
| 8 | agreement governing use of this software, this software is licensed |
| 9 | to you under the terms of the GNU General Public License version 2 |
| 10 | (the "GPL"), available at http://www.broadcom.com/licenses/GPLv2.php, |
| 11 | with the following added to such license: |
| 12 | |
| 13 | As a special exception, the copyright holders of this software give |
| 14 | you permission to link this software with independent modules, and |
| 15 | to copy and distribute the resulting executable under terms of your |
| 16 | choice, provided that you also meet, for each linked independent |
| 17 | module, the terms and conditions of the license of that module. |
| 18 | An independent module is a module which is not derived from this |
| 19 | software. The special exception does not apply to any modifications |
| 20 | of the software. |
| 21 | |
| 22 | Not withstanding the above, under no circumstances may you combine |
| 23 | this software in any way with any other Broadcom software provided |
| 24 | under a license other than the GPL, without Broadcom's express prior |
| 25 | written consent. |
| 26 | |
| 27 | :> |
| 28 | */ |
| 29 | |
| 30 | #ifndef _BCMOLT_USER_UTILS_H_ |
| 31 | #define _BCMOLT_USER_UTILS_H_ |
| 32 | |
| 33 | #include <bcmolt_model_types.h> |
| 34 | #include <bcmos_system.h> |
| 35 | #include <bcmolt_msg.h> |
| 36 | #include <bcmolt_fld.h> |
| 37 | |
| 38 | /* Validate that the given system mode is supported for the given device. |
| 39 | * This function returns BCM_ERR_OK if the system mode is valid or a different error code otherwise. */ |
| 40 | bcmos_errno bcmuser_system_mode_validate(bcmolt_devid device, bcmolt_system_mode system_mode); |
| 41 | |
| 42 | /* Read file from a file system into a buffer. */ |
| 43 | int bcmuser_image_read( |
| 44 | bcmolt_devid device, |
| 45 | bcmolt_device_image_type image_type, |
| 46 | uint32_t offset, |
| 47 | uint8_t *buf, |
| 48 | uint32_t buf_size); |
| 49 | |
| 50 | /* Turn off the processor of the embedded device. */ |
| 51 | bcmos_errno bcmuser_device_off(bcmolt_devid device); |
| 52 | |
| 53 | /* Turn on the processor of the embedded device. */ |
| 54 | bcmos_errno bcmuser_device_on(bcmolt_devid device); |
| 55 | |
| 56 | /* Check whether or not the embedded device processor is running. */ |
| 57 | bcmos_errno bcmuser_device_is_running(bcmolt_devid device, bcmos_bool *is_cpu_on); |
| 58 | |
| 59 | /* Prepare the PCIe bus for communication with the embedded devices */ |
| 60 | bcmos_errno bcmuser_pcie_prepare(void); |
| 61 | |
| 62 | /* Prepare the PCIe channel for communication with the embedded device. |
| 63 | * For example, this function may re-enumerate the PCI-E bus. */ |
| 64 | bcmos_errno bcmuser_pcie_channel_prepare(bcmolt_devid device); |
| 65 | |
| 66 | bcmos_errno bcmuser_pcie_channel_prepare_for_kt2(bcmolt_devid device); |
| 67 | |
| 68 | /* Remove the PCIe channel for communication with the embedded device. |
| 69 | * For example, this function may re-enumerate the PCI-E bus. */ |
| 70 | bcmos_errno bcmuser_pcie_channel_remove(bcmolt_devid device); |
| 71 | |
| 72 | /* Reset the host processor. */ |
| 73 | bcmos_errno bcmuser_host_reset(void); |
| 74 | |
| 75 | #endif |