diff options
author | Evan Lojewski <github@meklort.com> | 2019-05-05 17:12:21 -0600 |
---|---|---|
committer | Evan Lojewski <github@meklort.com> | 2019-05-05 17:12:21 -0600 |
commit | 2e776ab944dccf9f298bcc8300047821ceb9d34b (patch) | |
tree | f521312fc251b530cd8dfca13732fb9ca93170ac | |
parent | 34d06c104afdacd5b95ce9112667bd06bf57e0d5 (diff) | |
download | bcm5719-ortega-2e776ab944dccf9f298bcc8300047821ceb9d34b.tar.gz bcm5719-ortega-2e776ab944dccf9f298bcc8300047821ceb9d34b.zip |
Add additional SHM headers
-rw-r--r-- | include/APE_SHM1.h | 245 | ||||
-rw-r--r-- | include/APE_SHM2.h | 245 | ||||
-rw-r--r-- | include/APE_SHM3.h | 245 |
3 files changed, 735 insertions, 0 deletions
diff --git a/include/APE_SHM1.h b/include/APE_SHM1.h new file mode 100644 index 0000000..8a5b6b9 --- /dev/null +++ b/include/APE_SHM1.h @@ -0,0 +1,245 @@ +//////////////////////////////////////////////////////////////////////////////// +/// +/// @file APE_SHM1.h +/// +/// @project ape +/// +/// @brief APE_SHM1 +/// +//////////////////////////////////////////////////////////////////////////////// +/// +//////////////////////////////////////////////////////////////////////////////// +/// +/// @copyright Copyright (c) 2018, Evan Lojewski +/// @cond +/// +/// All rights reserved. +/// +/// Redistribution and use in source and binary forms, with or without +/// modification, are permitted provided that the following conditions are met: +/// 1. Redistributions of source code must retain the above copyright notice, +/// this list of conditions and the following disclaimer. +/// 2. Redistributions in binary form must reproduce the above copyright notice, +/// this list of conditions and the following disclaimer in the documentation +/// and/or other materials provided with the distribution. +/// 3. Neither the name of the <organization> nor the +/// names of its contributors may be used to endorse or promote products +/// derived from this software without specific prior written permission. +/// +//////////////////////////////////////////////////////////////////////////////// +/// +/// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +/// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +/// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +/// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +/// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +/// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +/// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +/// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +/// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +/// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +/// POSSIBILITY OF SUCH DAMAGE. +/// @endcond +//////////////////////////////////////////////////////////////////////////////// + +/** @defgroup APE_SHM1_H APE_SHM1 */ +/** @addtogroup APE_SHM1_H + * @{ + */ +#ifndef APE_SHM1_H +#define APE_SHM1_H + +#include <stdint.h> +#include "APE_SHM.h" + +#ifdef CXX_SIMULATOR /* Compiling c++ simulator code - uses register wrappers */ +void init_APE_SHM1_sim(void* base); +void init_APE_SHM1(void); + +#include <CXXRegister.h> +typedef CXXRegister<uint8_t, 0, 8> APE_SHM1_H_uint8_t; +typedef CXXRegister<uint16_t, 0, 16> APE_SHM1_H_uint16_t; +typedef CXXRegister<uint32_t, 0, 32> APE_SHM1_H_uint32_t; +#define APE_SHM1_H_uint8_t_bitfield(__pos__, __width__) CXXRegister<uint8_t, __pos__, __width__> +#define APE_SHM1_H_uint16_t_bitfield(__pos__, __width__) CXXRegister<uint16_t, __pos__, __width__> +#define APE_SHM1_H_uint32_t_bitfield(__pos__, __width__) CXXRegister<uint32_t, __pos__, __width__> +#define register_container struct +#define volatile +#define BITFIELD_BEGIN(__type__, __name__) struct { +#define BITFIELD_MEMBER(__type__, __name__, __offset__, __bits__) __type__##_bitfield(__offset__, __bits__) __name__; +#define BITFIELD_END(__type__, __name__) } __name__; + +#else /* Firmware Data types */ +typedef uint8_t APE_SHM1_H_uint8_t; +typedef uint16_t APE_SHM1_H_uint16_t; +typedef uint32_t APE_SHM1_H_uint32_t; +#define register_container union +#define BITFIELD_BEGIN(__type__, __name__) struct { +#define BITFIELD_MEMBER(__type__, __name__, __offset__, __bits__) __type__ __name__:__bits__; +#define BITFIELD_END(__type__, __name__) } __name__; +#endif /* !CXX_SIMULATOR */ + +#define REG_SHM1_BASE ((volatile void*)0x60221000) /* Device SHM Registers, function 1 */ +#define REG_SHM1_SIZE (sizeof(SHM_t)) + +#define REG_SHM1_SEG_SIG ((volatile APE_SHM1_H_uint32_t*)0x60221000) /* APE_APE_MAGIC ('APE!') when all is well. */ +#define SHM1_SEG_SIG_SIG_SHIFT 0u +#define SHM1_SEG_SIG_SIG_MASK 0xffffffffu +#define GET_SHM1_SEG_SIG_SIG(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM1_SEG_SIG_SIG(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM1_SEG_SIG_SIG_LOADER 0x10ad10adu + + +#define REG_SHM1_APE_SEG_LENGTH ((volatile APE_SHM1_H_uint32_t*)0x60221004) /* Set to 0x34. */ +#define REG_SHM1_FW_STATUS ((volatile APE_SHM1_H_uint32_t*)0x6022100c) /* */ +#define SHM1_FW_STATUS_READY_SHIFT 8u +#define SHM1_FW_STATUS_READY_MASK 0x100u +#define GET_SHM1_FW_STATUS_READY(__reg__) (((__reg__) & 0x100) >> 8u) +#define SET_SHM1_FW_STATUS_READY(__val__) (((__val__) << 8u) & 0x100u) +#define SHM1_FW_STATUS_UNKNOWN_31_28_SHIFT 28u +#define SHM1_FW_STATUS_UNKNOWN_31_28_MASK 0xf0000000u +#define GET_SHM1_FW_STATUS_UNKNOWN_31_28(__reg__) (((__reg__) & 0xf0000000) >> 28u) +#define SET_SHM1_FW_STATUS_UNKNOWN_31_28(__val__) (((__val__) << 28u) & 0xf0000000u) + +#define REG_SHM1_FW_FEATURES ((volatile APE_SHM1_H_uint32_t*)0x60221010) /* */ +#define SHM1_FW_FEATURES_NCSI_SHIFT 1u +#define SHM1_FW_FEATURES_NCSI_MASK 0x2u +#define GET_SHM1_FW_FEATURES_NCSI(__reg__) (((__reg__) & 0x2) >> 1u) +#define SET_SHM1_FW_FEATURES_NCSI(__val__) (((__val__) << 1u) & 0x2u) + +#define REG_SHM1_4014 ((volatile APE_SHM1_H_uint32_t*)0x60221014) /* Unknown. */ +#define REG_SHM1_FW_VERSION ((volatile APE_SHM1_H_uint32_t*)0x60221018) /* */ +#define SHM1_FW_VERSION_BUILD_SHIFT 0u +#define SHM1_FW_VERSION_BUILD_MASK 0xffu +#define GET_SHM1_FW_VERSION_BUILD(__reg__) (((__reg__) & 0xff) >> 0u) +#define SET_SHM1_FW_VERSION_BUILD(__val__) (((__val__) << 0u) & 0xffu) +#define SHM1_FW_VERSION_REVISION_SHIFT 8u +#define SHM1_FW_VERSION_REVISION_MASK 0xff00u +#define GET_SHM1_FW_VERSION_REVISION(__reg__) (((__reg__) & 0xff00) >> 8u) +#define SET_SHM1_FW_VERSION_REVISION(__val__) (((__val__) << 8u) & 0xff00u) +#define SHM1_FW_VERSION_MINOR_SHIFT 16u +#define SHM1_FW_VERSION_MINOR_MASK 0xff0000u +#define GET_SHM1_FW_VERSION_MINOR(__reg__) (((__reg__) & 0xff0000) >> 16u) +#define SET_SHM1_FW_VERSION_MINOR(__val__) (((__val__) << 16u) & 0xff0000u) +#define SHM1_FW_VERSION_MAJOR_SHIFT 24u +#define SHM1_FW_VERSION_MAJOR_MASK 0xff000000u +#define GET_SHM1_FW_VERSION_MAJOR(__reg__) (((__reg__) & 0xff000000) >> 24u) +#define SET_SHM1_FW_VERSION_MAJOR(__val__) (((__val__) << 24u) & 0xff000000u) + +#define REG_SHM1_SEG_MESSAGE_BUFFER_OFFSET ((volatile APE_SHM1_H_uint32_t*)0x6022101c) /* Specifies the offset of a scratchpad area, relative to the start of the APE SHM area (i.e., relative to APE_REG(0x4000)). */ +#define REG_SHM1_SEG_MESSAGE_BUFFER_LENGTH ((volatile APE_SHM1_H_uint32_t*)0x60221020) /* Specifies the size of the scratchpad area in bytes. */ +#define REG_SHM1_4024 ((volatile APE_SHM1_H_uint32_t*)0x60221024) /* Unknown. Bootcode related. */ +#define REG_SHM1_4028 ((volatile APE_SHM1_H_uint32_t*)0x60221028) /* Unknown. Bootcode related. */ +#define REG_SHM1_LOADER_COMMAND ((volatile APE_SHM1_H_uint32_t*)0x60221038) /* Command sent when using the the APE loader. Zero once handled. */ +#define SHM1_LOADER_COMMAND_COMMAND_SHIFT 0u +#define SHM1_LOADER_COMMAND_COMMAND_MASK 0xffffffffu +#define GET_SHM1_LOADER_COMMAND_COMMAND(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM1_LOADER_COMMAND_COMMAND(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM1_LOADER_COMMAND_COMMAND_NOP 0x0u +#define SHM1_LOADER_COMMAND_COMMAND_READ_MEM 0x1u +#define SHM1_LOADER_COMMAND_COMMAND_WRITE_MEM 0x2u +#define SHM1_LOADER_COMMAND_COMMAND_CALL 0x3u + + +#define REG_SHM1_LOADER_ARG0 ((volatile APE_SHM1_H_uint32_t*)0x6022103c) /* Argument 0 for the APE loader. */ +#define REG_SHM1_LOADER_ARG1 ((volatile APE_SHM1_H_uint32_t*)0x60221040) /* Argument 1 for the APE loader. */ +#define REG_SHM1_RCPU_SEG_SIG ((volatile APE_SHM1_H_uint32_t*)0x60221100) /* Set to APE_RCPU_MAGIC ('RCPU') by RX CPU. */ +#define SHM1_RCPU_SEG_SIG_SIG_SHIFT 0u +#define SHM1_RCPU_SEG_SIG_SIG_MASK 0xffffffffu +#define GET_SHM1_RCPU_SEG_SIG_SIG(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM1_RCPU_SEG_SIG_SIG(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM1_RCPU_SEG_SIG_SIG_RCPU_MAGIC 0x52435055u + + +#define REG_SHM1_RCPU_SEG_LENGTH ((volatile APE_SHM1_H_uint32_t*)0x60221104) /* Set to 0x34. */ +#define REG_SHM1_RCPU_INIT_COUNT ((volatile APE_SHM1_H_uint32_t*)0x60221108) /* Incremented by RX CPU every boot. */ +#define REG_SHM1_RCPU_FW_VERSION ((volatile APE_SHM1_H_uint32_t*)0x6022110c) /* Set to the bootcode version. e.g. 0x0127 -> v1.39. */ +#define REG_SHM1_RCPU_CFG_FEATURE ((volatile APE_SHM1_H_uint32_t*)0x60221110) /* Set to */ +#define REG_SHM1_RCPU_PCI_VENDOR_DEVICE_ID ((volatile APE_SHM1_H_uint32_t*)0x60221114) /* Set to PCI Vendor/Device ID by S2. */ +#define REG_SHM1_RCPU_PCI_SUBSYSTEM_ID ((volatile APE_SHM1_H_uint32_t*)0x60221118) /* Set to PCI Subsystem Vendor/Subsystem ID by S2. */ +#define REG_SHM1_RCPU_APE_RESET_COUNT ((volatile APE_SHM1_H_uint32_t*)0x6022111c) /* Unknown. Incremented by frobnicating routine. */ +#define REG_SHM1_RCPU_LAST_APE_STATUS ((volatile APE_SHM1_H_uint32_t*)0x60221120) /* Unknown. Written by frobnicating routine. */ +#define REG_SHM1_RCPU_LAST_APE_FW_STATUS ((volatile APE_SHM1_H_uint32_t*)0x60221124) /* Unknown. */ +#define REG_SHM1_RCPU_CFG_HW ((volatile APE_SHM1_H_uint32_t*)0x60221128) /* Set from */ +#define REG_SHM1_RCPU_CFG_HW_2 ((volatile APE_SHM1_H_uint32_t*)0x6022112c) /* Set from */ +#define REG_SHM1_RCPU_CPMU_STATUS ((volatile APE_SHM1_H_uint32_t*)0x60221130) /* Set from */ +#define SHM1_RCPU_CPMU_STATUS_ADDRESS_SHIFT 0u +#define SHM1_RCPU_CPMU_STATUS_ADDRESS_MASK 0xffffu +#define GET_SHM1_RCPU_CPMU_STATUS_ADDRESS(__reg__) (((__reg__) & 0xffff) >> 0u) +#define SET_SHM1_RCPU_CPMU_STATUS_ADDRESS(__val__) (((__val__) << 0u) & 0xffffu) +#define SHM1_RCPU_CPMU_STATUS_ADDRESS_ADDRESS 0x362cu + +#define SHM1_RCPU_CPMU_STATUS_STATUS_SHIFT 16u +#define SHM1_RCPU_CPMU_STATUS_STATUS_MASK 0xffff0000u +#define GET_SHM1_RCPU_CPMU_STATUS_STATUS(__reg__) (((__reg__) & 0xffff0000) >> 16u) +#define SET_SHM1_RCPU_CPMU_STATUS_STATUS(__val__) (((__val__) << 16u) & 0xffff0000u) + +#define REG_SHM1_HOST_SEG_SIG ((volatile APE_SHM1_H_uint32_t*)0x60221200) /* Set to APE_HOST_MAGIC ('HOST') to indicate the section is valid. */ +#define REG_SHM1_HOST_SEG_LEN ((volatile APE_SHM1_H_uint32_t*)0x60221204) /* Set to 0x20. */ +#define REG_SHM1_HOST_INIT_COUNT ((volatile APE_SHM1_H_uint32_t*)0x60221208) /* Incremented by host on every initialization. */ +#define REG_SHM1_HOST_DRIVER_ID ((volatile APE_SHM1_H_uint32_t*)0x6022120c) /* Linux sets this to 0xF0MM_mm00, where M is the major version of Linux and m is the minor version. */ +#define REG_SHM1_HOST_BEHAVIOR ((volatile APE_SHM1_H_uint32_t*)0x60221210) /* */ +#define SHM1_HOST_BEHAVIOR_NO_PHYLOCK_SHIFT 0u +#define SHM1_HOST_BEHAVIOR_NO_PHYLOCK_MASK 0x1u +#define GET_SHM1_HOST_BEHAVIOR_NO_PHYLOCK(__reg__) (((__reg__) & 0x1) >> 0u) +#define SET_SHM1_HOST_BEHAVIOR_NO_PHYLOCK(__val__) (((__val__) << 0u) & 0x1u) + +#define REG_SHM1_HEARTBEAT_INTERVAL ((volatile APE_SHM1_H_uint32_t*)0x60221214) /* In milliseconds. Set to 0 to disable heartbeating. */ +#define REG_SHM1_HEARTBEAT_COUNT ((volatile APE_SHM1_H_uint32_t*)0x60221218) /* */ +#define REG_SHM1_HOST_DRIVER_STATE ((volatile APE_SHM1_H_uint32_t*)0x6022121c) /* */ +#define REG_SHM1_WOL_SPEED ((volatile APE_SHM1_H_uint32_t*)0x60221224) /* */ +#define REG_SHM1_EVENT_STATUS ((volatile APE_SHM1_H_uint32_t*)0x60221300) /* */ +#define SHM1_EVENT_STATUS_DRIVER_EVENT_SHIFT 4u +#define SHM1_EVENT_STATUS_DRIVER_EVENT_MASK 0x10u +#define GET_SHM1_EVENT_STATUS_DRIVER_EVENT(__reg__) (((__reg__) & 0x10) >> 4u) +#define SET_SHM1_EVENT_STATUS_DRIVER_EVENT(__val__) (((__val__) << 4u) & 0x10u) +#define SHM1_EVENT_STATUS_COMMAND_SHIFT 8u +#define SHM1_EVENT_STATUS_COMMAND_MASK 0xff00u +#define GET_SHM1_EVENT_STATUS_COMMAND(__reg__) (((__reg__) & 0xff00) >> 8u) +#define SET_SHM1_EVENT_STATUS_COMMAND(__val__) (((__val__) << 8u) & 0xff00u) +#define SHM1_EVENT_STATUS_COMMAND_STATE_CHANGE 0x5u +#define SHM1_EVENT_STATUS_COMMAND_SCRATCHPAD_READ 0x16u +#define SHM1_EVENT_STATUS_COMMAND_SCRATCHPAD_WRITE 0x17u + +#define SHM1_EVENT_STATUS_STATE_SHIFT 16u +#define SHM1_EVENT_STATUS_STATE_MASK 0x70000u +#define GET_SHM1_EVENT_STATUS_STATE(__reg__) (((__reg__) & 0x70000) >> 16u) +#define SET_SHM1_EVENT_STATUS_STATE(__val__) (((__val__) << 16u) & 0x70000u) +#define SHM1_EVENT_STATUS_STATE_START 0x1u +#define SHM1_EVENT_STATUS_STATE_UNLOAD 0x2u +#define SHM1_EVENT_STATUS_STATE_WOL 0x3u +#define SHM1_EVENT_STATUS_STATE_SUSPEND 0x4u + +#define SHM1_EVENT_STATUS_PENDING_SHIFT 31u +#define SHM1_EVENT_STATUS_PENDING_MASK 0x80000000u +#define GET_SHM1_EVENT_STATUS_PENDING(__reg__) (((__reg__) & 0x80000000) >> 31u) +#define SET_SHM1_EVENT_STATUS_PENDING(__val__) (((__val__) << 31u) & 0x80000000u) + +#define REG_SHM1_PROT_MAGIC ((volatile APE_SHM1_H_uint32_t*)0x60221308) /* This is set to APE_PROT_MAGIC ('PROT') on all functions. If it is 'PROT', the following fields (MAC0_HIGH/LOW) are valid */ +#define REG_SHM1_PROT_MAC0_HIGH ((volatile APE_SHM1_H_uint32_t*)0x60221314) /* High 16 bits of MAC address 0. Only valid if */ +#define REG_SHM1_PROT_MAC0_LOW ((volatile APE_SHM1_H_uint32_t*)0x60221318) /* Low 16 bits of MAC address 0. */ +#define REG_SHM1_NCSI_SIG ((volatile APE_SHM1_H_uint32_t*)0x60221800) /* Set to NCSI_MAGIC ('NCSI') by APE firmware. NOTE: all words in the NCSI section are available in the function 0 SHM area only. */ +#define REG_SHM1_NCSI_BUILD_TIME ((volatile APE_SHM1_H_uint32_t*)0x60221810) /* ASCII string spanning three 32-bit words. Unused trailing bytes are set to zero. */ +#define REG_SHM1_NCSI_BUILD_TIME_2 ((volatile APE_SHM1_H_uint32_t*)0x60221814) /* */ +#define REG_SHM1_NCSI_BUILD_TIME_3 ((volatile APE_SHM1_H_uint32_t*)0x60221818) /* */ +#define REG_SHM1_NCSI_BUILD_DATE ((volatile APE_SHM1_H_uint32_t*)0x6022181c) /* ASCII string spanning three 32-bit words. Unused trailing bytes are set to zero. */ +#define REG_SHM1_NCSI_BUILD_DATE_2 ((volatile APE_SHM1_H_uint32_t*)0x60221820) /* */ +#define REG_SHM1_NCSI_BUILD_DATE_3 ((volatile APE_SHM1_H_uint32_t*)0x60221824) /* */ +#define REG_SHM1_CHIP_ID ((volatile APE_SHM1_H_uint32_t*)0x60221890) /* The APE code copies the contents of Chip ID to this word */ +/** @brief Device SHM Registers, function 1 */ +extern volatile SHM_t SHM1; + + + +#ifdef CXX_SIMULATOR /* Compiling c++ code - uses register wrappers */ +#undef volatile +#endif /* CXX_SIMULATOR */ + +#undef register_container +#undef BITFIELD_BEGIN +#undef BITFIELD_MEMBER +#undef BITFIELD_END + +#endif /* !APE_SHM1_H */ + +/** @} */ diff --git a/include/APE_SHM2.h b/include/APE_SHM2.h new file mode 100644 index 0000000..313582a --- /dev/null +++ b/include/APE_SHM2.h @@ -0,0 +1,245 @@ +//////////////////////////////////////////////////////////////////////////////// +/// +/// @file APE_SHM2.h +/// +/// @project ape +/// +/// @brief APE_SHM2 +/// +//////////////////////////////////////////////////////////////////////////////// +/// +//////////////////////////////////////////////////////////////////////////////// +/// +/// @copyright Copyright (c) 2018, Evan Lojewski +/// @cond +/// +/// All rights reserved. +/// +/// Redistribution and use in source and binary forms, with or without +/// modification, are permitted provided that the following conditions are met: +/// 1. Redistributions of source code must retain the above copyright notice, +/// this list of conditions and the following disclaimer. +/// 2. Redistributions in binary form must reproduce the above copyright notice, +/// this list of conditions and the following disclaimer in the documentation +/// and/or other materials provided with the distribution. +/// 3. Neither the name of the <organization> nor the +/// names of its contributors may be used to endorse or promote products +/// derived from this software without specific prior written permission. +/// +//////////////////////////////////////////////////////////////////////////////// +/// +/// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +/// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +/// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +/// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +/// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +/// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +/// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +/// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +/// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +/// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +/// POSSIBILITY OF SUCH DAMAGE. +/// @endcond +//////////////////////////////////////////////////////////////////////////////// + +/** @defgroup APE_SHM2_H APE_SHM2 */ +/** @addtogroup APE_SHM2_H + * @{ + */ +#ifndef APE_SHM2_H +#define APE_SHM2_H + +#include <stdint.h> +#include "APE_SHM.h" + +#ifdef CXX_SIMULATOR /* Compiling c++ simulator code - uses register wrappers */ +void init_APE_SHM2_sim(void* base); +void init_APE_SHM2(void); + +#include <CXXRegister.h> +typedef CXXRegister<uint8_t, 0, 8> APE_SHM2_H_uint8_t; +typedef CXXRegister<uint16_t, 0, 16> APE_SHM2_H_uint16_t; +typedef CXXRegister<uint32_t, 0, 32> APE_SHM2_H_uint32_t; +#define APE_SHM2_H_uint8_t_bitfield(__pos__, __width__) CXXRegister<uint8_t, __pos__, __width__> +#define APE_SHM2_H_uint16_t_bitfield(__pos__, __width__) CXXRegister<uint16_t, __pos__, __width__> +#define APE_SHM2_H_uint32_t_bitfield(__pos__, __width__) CXXRegister<uint32_t, __pos__, __width__> +#define register_container struct +#define volatile +#define BITFIELD_BEGIN(__type__, __name__) struct { +#define BITFIELD_MEMBER(__type__, __name__, __offset__, __bits__) __type__##_bitfield(__offset__, __bits__) __name__; +#define BITFIELD_END(__type__, __name__) } __name__; + +#else /* Firmware Data types */ +typedef uint8_t APE_SHM2_H_uint8_t; +typedef uint16_t APE_SHM2_H_uint16_t; +typedef uint32_t APE_SHM2_H_uint32_t; +#define register_container union +#define BITFIELD_BEGIN(__type__, __name__) struct { +#define BITFIELD_MEMBER(__type__, __name__, __offset__, __bits__) __type__ __name__:__bits__; +#define BITFIELD_END(__type__, __name__) } __name__; +#endif /* !CXX_SIMULATOR */ + +#define REG_SHM2_BASE ((volatile void*)0x60222000) /* Device SHM Registers, function 2 */ +#define REG_SHM2_SIZE (sizeof(SHM_t)) + +#define REG_SHM2_SEG_SIG ((volatile APE_SHM2_H_uint32_t*)0x60222000) /* APE_APE_MAGIC ('APE!') when all is well. */ +#define SHM2_SEG_SIG_SIG_SHIFT 0u +#define SHM2_SEG_SIG_SIG_MASK 0xffffffffu +#define GET_SHM2_SEG_SIG_SIG(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM2_SEG_SIG_SIG(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM2_SEG_SIG_SIG_LOADER 0x10ad10adu + + +#define REG_SHM2_APE_SEG_LENGTH ((volatile APE_SHM2_H_uint32_t*)0x60222004) /* Set to 0x34. */ +#define REG_SHM2_FW_STATUS ((volatile APE_SHM2_H_uint32_t*)0x6022200c) /* */ +#define SHM2_FW_STATUS_READY_SHIFT 8u +#define SHM2_FW_STATUS_READY_MASK 0x100u +#define GET_SHM2_FW_STATUS_READY(__reg__) (((__reg__) & 0x100) >> 8u) +#define SET_SHM2_FW_STATUS_READY(__val__) (((__val__) << 8u) & 0x100u) +#define SHM2_FW_STATUS_UNKNOWN_31_28_SHIFT 28u +#define SHM2_FW_STATUS_UNKNOWN_31_28_MASK 0xf0000000u +#define GET_SHM2_FW_STATUS_UNKNOWN_31_28(__reg__) (((__reg__) & 0xf0000000) >> 28u) +#define SET_SHM2_FW_STATUS_UNKNOWN_31_28(__val__) (((__val__) << 28u) & 0xf0000000u) + +#define REG_SHM2_FW_FEATURES ((volatile APE_SHM2_H_uint32_t*)0x60222010) /* */ +#define SHM2_FW_FEATURES_NCSI_SHIFT 1u +#define SHM2_FW_FEATURES_NCSI_MASK 0x2u +#define GET_SHM2_FW_FEATURES_NCSI(__reg__) (((__reg__) & 0x2) >> 1u) +#define SET_SHM2_FW_FEATURES_NCSI(__val__) (((__val__) << 1u) & 0x2u) + +#define REG_SHM2_4014 ((volatile APE_SHM2_H_uint32_t*)0x60222014) /* Unknown. */ +#define REG_SHM2_FW_VERSION ((volatile APE_SHM2_H_uint32_t*)0x60222018) /* */ +#define SHM2_FW_VERSION_BUILD_SHIFT 0u +#define SHM2_FW_VERSION_BUILD_MASK 0xffu +#define GET_SHM2_FW_VERSION_BUILD(__reg__) (((__reg__) & 0xff) >> 0u) +#define SET_SHM2_FW_VERSION_BUILD(__val__) (((__val__) << 0u) & 0xffu) +#define SHM2_FW_VERSION_REVISION_SHIFT 8u +#define SHM2_FW_VERSION_REVISION_MASK 0xff00u +#define GET_SHM2_FW_VERSION_REVISION(__reg__) (((__reg__) & 0xff00) >> 8u) +#define SET_SHM2_FW_VERSION_REVISION(__val__) (((__val__) << 8u) & 0xff00u) +#define SHM2_FW_VERSION_MINOR_SHIFT 16u +#define SHM2_FW_VERSION_MINOR_MASK 0xff0000u +#define GET_SHM2_FW_VERSION_MINOR(__reg__) (((__reg__) & 0xff0000) >> 16u) +#define SET_SHM2_FW_VERSION_MINOR(__val__) (((__val__) << 16u) & 0xff0000u) +#define SHM2_FW_VERSION_MAJOR_SHIFT 24u +#define SHM2_FW_VERSION_MAJOR_MASK 0xff000000u +#define GET_SHM2_FW_VERSION_MAJOR(__reg__) (((__reg__) & 0xff000000) >> 24u) +#define SET_SHM2_FW_VERSION_MAJOR(__val__) (((__val__) << 24u) & 0xff000000u) + +#define REG_SHM2_SEG_MESSAGE_BUFFER_OFFSET ((volatile APE_SHM2_H_uint32_t*)0x6022201c) /* Specifies the offset of a scratchpad area, relative to the start of the APE SHM area (i.e., relative to APE_REG(0x4000)). */ +#define REG_SHM2_SEG_MESSAGE_BUFFER_LENGTH ((volatile APE_SHM2_H_uint32_t*)0x60222020) /* Specifies the size of the scratchpad area in bytes. */ +#define REG_SHM2_4024 ((volatile APE_SHM2_H_uint32_t*)0x60222024) /* Unknown. Bootcode related. */ +#define REG_SHM2_4028 ((volatile APE_SHM2_H_uint32_t*)0x60222028) /* Unknown. Bootcode related. */ +#define REG_SHM2_LOADER_COMMAND ((volatile APE_SHM2_H_uint32_t*)0x60222038) /* Command sent when using the the APE loader. Zero once handled. */ +#define SHM2_LOADER_COMMAND_COMMAND_SHIFT 0u +#define SHM2_LOADER_COMMAND_COMMAND_MASK 0xffffffffu +#define GET_SHM2_LOADER_COMMAND_COMMAND(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM2_LOADER_COMMAND_COMMAND(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM2_LOADER_COMMAND_COMMAND_NOP 0x0u +#define SHM2_LOADER_COMMAND_COMMAND_READ_MEM 0x1u +#define SHM2_LOADER_COMMAND_COMMAND_WRITE_MEM 0x2u +#define SHM2_LOADER_COMMAND_COMMAND_CALL 0x3u + + +#define REG_SHM2_LOADER_ARG0 ((volatile APE_SHM2_H_uint32_t*)0x6022203c) /* Argument 0 for the APE loader. */ +#define REG_SHM2_LOADER_ARG1 ((volatile APE_SHM2_H_uint32_t*)0x60222040) /* Argument 1 for the APE loader. */ +#define REG_SHM2_RCPU_SEG_SIG ((volatile APE_SHM2_H_uint32_t*)0x60222100) /* Set to APE_RCPU_MAGIC ('RCPU') by RX CPU. */ +#define SHM2_RCPU_SEG_SIG_SIG_SHIFT 0u +#define SHM2_RCPU_SEG_SIG_SIG_MASK 0xffffffffu +#define GET_SHM2_RCPU_SEG_SIG_SIG(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM2_RCPU_SEG_SIG_SIG(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM2_RCPU_SEG_SIG_SIG_RCPU_MAGIC 0x52435055u + + +#define REG_SHM2_RCPU_SEG_LENGTH ((volatile APE_SHM2_H_uint32_t*)0x60222104) /* Set to 0x34. */ +#define REG_SHM2_RCPU_INIT_COUNT ((volatile APE_SHM2_H_uint32_t*)0x60222108) /* Incremented by RX CPU every boot. */ +#define REG_SHM2_RCPU_FW_VERSION ((volatile APE_SHM2_H_uint32_t*)0x6022210c) /* Set to the bootcode version. e.g. 0x0127 -> v1.39. */ +#define REG_SHM2_RCPU_CFG_FEATURE ((volatile APE_SHM2_H_uint32_t*)0x60222110) /* Set to */ +#define REG_SHM2_RCPU_PCI_VENDOR_DEVICE_ID ((volatile APE_SHM2_H_uint32_t*)0x60222114) /* Set to PCI Vendor/Device ID by S2. */ +#define REG_SHM2_RCPU_PCI_SUBSYSTEM_ID ((volatile APE_SHM2_H_uint32_t*)0x60222118) /* Set to PCI Subsystem Vendor/Subsystem ID by S2. */ +#define REG_SHM2_RCPU_APE_RESET_COUNT ((volatile APE_SHM2_H_uint32_t*)0x6022211c) /* Unknown. Incremented by frobnicating routine. */ +#define REG_SHM2_RCPU_LAST_APE_STATUS ((volatile APE_SHM2_H_uint32_t*)0x60222120) /* Unknown. Written by frobnicating routine. */ +#define REG_SHM2_RCPU_LAST_APE_FW_STATUS ((volatile APE_SHM2_H_uint32_t*)0x60222124) /* Unknown. */ +#define REG_SHM2_RCPU_CFG_HW ((volatile APE_SHM2_H_uint32_t*)0x60222128) /* Set from */ +#define REG_SHM2_RCPU_CFG_HW_2 ((volatile APE_SHM2_H_uint32_t*)0x6022212c) /* Set from */ +#define REG_SHM2_RCPU_CPMU_STATUS ((volatile APE_SHM2_H_uint32_t*)0x60222130) /* Set from */ +#define SHM2_RCPU_CPMU_STATUS_ADDRESS_SHIFT 0u +#define SHM2_RCPU_CPMU_STATUS_ADDRESS_MASK 0xffffu +#define GET_SHM2_RCPU_CPMU_STATUS_ADDRESS(__reg__) (((__reg__) & 0xffff) >> 0u) +#define SET_SHM2_RCPU_CPMU_STATUS_ADDRESS(__val__) (((__val__) << 0u) & 0xffffu) +#define SHM2_RCPU_CPMU_STATUS_ADDRESS_ADDRESS 0x362cu + +#define SHM2_RCPU_CPMU_STATUS_STATUS_SHIFT 16u +#define SHM2_RCPU_CPMU_STATUS_STATUS_MASK 0xffff0000u +#define GET_SHM2_RCPU_CPMU_STATUS_STATUS(__reg__) (((__reg__) & 0xffff0000) >> 16u) +#define SET_SHM2_RCPU_CPMU_STATUS_STATUS(__val__) (((__val__) << 16u) & 0xffff0000u) + +#define REG_SHM2_HOST_SEG_SIG ((volatile APE_SHM2_H_uint32_t*)0x60222200) /* Set to APE_HOST_MAGIC ('HOST') to indicate the section is valid. */ +#define REG_SHM2_HOST_SEG_LEN ((volatile APE_SHM2_H_uint32_t*)0x60222204) /* Set to 0x20. */ +#define REG_SHM2_HOST_INIT_COUNT ((volatile APE_SHM2_H_uint32_t*)0x60222208) /* Incremented by host on every initialization. */ +#define REG_SHM2_HOST_DRIVER_ID ((volatile APE_SHM2_H_uint32_t*)0x6022220c) /* Linux sets this to 0xF0MM_mm00, where M is the major version of Linux and m is the minor version. */ +#define REG_SHM2_HOST_BEHAVIOR ((volatile APE_SHM2_H_uint32_t*)0x60222210) /* */ +#define SHM2_HOST_BEHAVIOR_NO_PHYLOCK_SHIFT 0u +#define SHM2_HOST_BEHAVIOR_NO_PHYLOCK_MASK 0x1u +#define GET_SHM2_HOST_BEHAVIOR_NO_PHYLOCK(__reg__) (((__reg__) & 0x1) >> 0u) +#define SET_SHM2_HOST_BEHAVIOR_NO_PHYLOCK(__val__) (((__val__) << 0u) & 0x1u) + +#define REG_SHM2_HEARTBEAT_INTERVAL ((volatile APE_SHM2_H_uint32_t*)0x60222214) /* In milliseconds. Set to 0 to disable heartbeating. */ +#define REG_SHM2_HEARTBEAT_COUNT ((volatile APE_SHM2_H_uint32_t*)0x60222218) /* */ +#define REG_SHM2_HOST_DRIVER_STATE ((volatile APE_SHM2_H_uint32_t*)0x6022221c) /* */ +#define REG_SHM2_WOL_SPEED ((volatile APE_SHM2_H_uint32_t*)0x60222224) /* */ +#define REG_SHM2_EVENT_STATUS ((volatile APE_SHM2_H_uint32_t*)0x60222300) /* */ +#define SHM2_EVENT_STATUS_DRIVER_EVENT_SHIFT 4u +#define SHM2_EVENT_STATUS_DRIVER_EVENT_MASK 0x10u +#define GET_SHM2_EVENT_STATUS_DRIVER_EVENT(__reg__) (((__reg__) & 0x10) >> 4u) +#define SET_SHM2_EVENT_STATUS_DRIVER_EVENT(__val__) (((__val__) << 4u) & 0x10u) +#define SHM2_EVENT_STATUS_COMMAND_SHIFT 8u +#define SHM2_EVENT_STATUS_COMMAND_MASK 0xff00u +#define GET_SHM2_EVENT_STATUS_COMMAND(__reg__) (((__reg__) & 0xff00) >> 8u) +#define SET_SHM2_EVENT_STATUS_COMMAND(__val__) (((__val__) << 8u) & 0xff00u) +#define SHM2_EVENT_STATUS_COMMAND_STATE_CHANGE 0x5u +#define SHM2_EVENT_STATUS_COMMAND_SCRATCHPAD_READ 0x16u +#define SHM2_EVENT_STATUS_COMMAND_SCRATCHPAD_WRITE 0x17u + +#define SHM2_EVENT_STATUS_STATE_SHIFT 16u +#define SHM2_EVENT_STATUS_STATE_MASK 0x70000u +#define GET_SHM2_EVENT_STATUS_STATE(__reg__) (((__reg__) & 0x70000) >> 16u) +#define SET_SHM2_EVENT_STATUS_STATE(__val__) (((__val__) << 16u) & 0x70000u) +#define SHM2_EVENT_STATUS_STATE_START 0x1u +#define SHM2_EVENT_STATUS_STATE_UNLOAD 0x2u +#define SHM2_EVENT_STATUS_STATE_WOL 0x3u +#define SHM2_EVENT_STATUS_STATE_SUSPEND 0x4u + +#define SHM2_EVENT_STATUS_PENDING_SHIFT 31u +#define SHM2_EVENT_STATUS_PENDING_MASK 0x80000000u +#define GET_SHM2_EVENT_STATUS_PENDING(__reg__) (((__reg__) & 0x80000000) >> 31u) +#define SET_SHM2_EVENT_STATUS_PENDING(__val__) (((__val__) << 31u) & 0x80000000u) + +#define REG_SHM2_PROT_MAGIC ((volatile APE_SHM2_H_uint32_t*)0x60222308) /* This is set to APE_PROT_MAGIC ('PROT') on all functions. If it is 'PROT', the following fields (MAC0_HIGH/LOW) are valid */ +#define REG_SHM2_PROT_MAC0_HIGH ((volatile APE_SHM2_H_uint32_t*)0x60222314) /* High 16 bits of MAC address 0. Only valid if */ +#define REG_SHM2_PROT_MAC0_LOW ((volatile APE_SHM2_H_uint32_t*)0x60222318) /* Low 16 bits of MAC address 0. */ +#define REG_SHM2_NCSI_SIG ((volatile APE_SHM2_H_uint32_t*)0x60222800) /* Set to NCSI_MAGIC ('NCSI') by APE firmware. NOTE: all words in the NCSI section are available in the function 0 SHM area only. */ +#define REG_SHM2_NCSI_BUILD_TIME ((volatile APE_SHM2_H_uint32_t*)0x60222810) /* ASCII string spanning three 32-bit words. Unused trailing bytes are set to zero. */ +#define REG_SHM2_NCSI_BUILD_TIME_2 ((volatile APE_SHM2_H_uint32_t*)0x60222814) /* */ +#define REG_SHM2_NCSI_BUILD_TIME_3 ((volatile APE_SHM2_H_uint32_t*)0x60222818) /* */ +#define REG_SHM2_NCSI_BUILD_DATE ((volatile APE_SHM2_H_uint32_t*)0x6022281c) /* ASCII string spanning three 32-bit words. Unused trailing bytes are set to zero. */ +#define REG_SHM2_NCSI_BUILD_DATE_2 ((volatile APE_SHM2_H_uint32_t*)0x60222820) /* */ +#define REG_SHM2_NCSI_BUILD_DATE_3 ((volatile APE_SHM2_H_uint32_t*)0x60222824) /* */ +#define REG_SHM2_CHIP_ID ((volatile APE_SHM2_H_uint32_t*)0x60222890) /* The APE code copies the contents of Chip ID to this word */ +/** @brief Device SHM Registers, function 2 */ +extern volatile SHM_t SHM2; + + + +#ifdef CXX_SIMULATOR /* Compiling c++ code - uses register wrappers */ +#undef volatile +#endif /* CXX_SIMULATOR */ + +#undef register_container +#undef BITFIELD_BEGIN +#undef BITFIELD_MEMBER +#undef BITFIELD_END + +#endif /* !APE_SHM2_H */ + +/** @} */ diff --git a/include/APE_SHM3.h b/include/APE_SHM3.h new file mode 100644 index 0000000..914c1ad --- /dev/null +++ b/include/APE_SHM3.h @@ -0,0 +1,245 @@ +//////////////////////////////////////////////////////////////////////////////// +/// +/// @file APE_SHM3.h +/// +/// @project ape +/// +/// @brief APE_SHM3 +/// +//////////////////////////////////////////////////////////////////////////////// +/// +//////////////////////////////////////////////////////////////////////////////// +/// +/// @copyright Copyright (c) 2018, Evan Lojewski +/// @cond +/// +/// All rights reserved. +/// +/// Redistribution and use in source and binary forms, with or without +/// modification, are permitted provided that the following conditions are met: +/// 1. Redistributions of source code must retain the above copyright notice, +/// this list of conditions and the following disclaimer. +/// 2. Redistributions in binary form must reproduce the above copyright notice, +/// this list of conditions and the following disclaimer in the documentation +/// and/or other materials provided with the distribution. +/// 3. Neither the name of the <organization> nor the +/// names of its contributors may be used to endorse or promote products +/// derived from this software without specific prior written permission. +/// +//////////////////////////////////////////////////////////////////////////////// +/// +/// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +/// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +/// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +/// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +/// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +/// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +/// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +/// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +/// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +/// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +/// POSSIBILITY OF SUCH DAMAGE. +/// @endcond +//////////////////////////////////////////////////////////////////////////////// + +/** @defgroup APE_SHM3_H APE_SHM3 */ +/** @addtogroup APE_SHM3_H + * @{ + */ +#ifndef APE_SHM3_H +#define APE_SHM3_H + +#include <stdint.h> +#include "APE_SHM.h" + +#ifdef CXX_SIMULATOR /* Compiling c++ simulator code - uses register wrappers */ +void init_APE_SHM3_sim(void* base); +void init_APE_SHM3(void); + +#include <CXXRegister.h> +typedef CXXRegister<uint8_t, 0, 8> APE_SHM3_H_uint8_t; +typedef CXXRegister<uint16_t, 0, 16> APE_SHM3_H_uint16_t; +typedef CXXRegister<uint32_t, 0, 32> APE_SHM3_H_uint32_t; +#define APE_SHM3_H_uint8_t_bitfield(__pos__, __width__) CXXRegister<uint8_t, __pos__, __width__> +#define APE_SHM3_H_uint16_t_bitfield(__pos__, __width__) CXXRegister<uint16_t, __pos__, __width__> +#define APE_SHM3_H_uint32_t_bitfield(__pos__, __width__) CXXRegister<uint32_t, __pos__, __width__> +#define register_container struct +#define volatile +#define BITFIELD_BEGIN(__type__, __name__) struct { +#define BITFIELD_MEMBER(__type__, __name__, __offset__, __bits__) __type__##_bitfield(__offset__, __bits__) __name__; +#define BITFIELD_END(__type__, __name__) } __name__; + +#else /* Firmware Data types */ +typedef uint8_t APE_SHM3_H_uint8_t; +typedef uint16_t APE_SHM3_H_uint16_t; +typedef uint32_t APE_SHM3_H_uint32_t; +#define register_container union +#define BITFIELD_BEGIN(__type__, __name__) struct { +#define BITFIELD_MEMBER(__type__, __name__, __offset__, __bits__) __type__ __name__:__bits__; +#define BITFIELD_END(__type__, __name__) } __name__; +#endif /* !CXX_SIMULATOR */ + +#define REG_SHM3_BASE ((volatile void*)0x60223000) /* Device SHM Registers, function 3 */ +#define REG_SHM3_SIZE (sizeof(SHM_t)) + +#define REG_SHM3_SEG_SIG ((volatile APE_SHM3_H_uint32_t*)0x60223000) /* APE_APE_MAGIC ('APE!') when all is well. */ +#define SHM3_SEG_SIG_SIG_SHIFT 0u +#define SHM3_SEG_SIG_SIG_MASK 0xffffffffu +#define GET_SHM3_SEG_SIG_SIG(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM3_SEG_SIG_SIG(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM3_SEG_SIG_SIG_LOADER 0x10ad10adu + + +#define REG_SHM3_APE_SEG_LENGTH ((volatile APE_SHM3_H_uint32_t*)0x60223004) /* Set to 0x34. */ +#define REG_SHM3_FW_STATUS ((volatile APE_SHM3_H_uint32_t*)0x6022300c) /* */ +#define SHM3_FW_STATUS_READY_SHIFT 8u +#define SHM3_FW_STATUS_READY_MASK 0x100u +#define GET_SHM3_FW_STATUS_READY(__reg__) (((__reg__) & 0x100) >> 8u) +#define SET_SHM3_FW_STATUS_READY(__val__) (((__val__) << 8u) & 0x100u) +#define SHM3_FW_STATUS_UNKNOWN_31_28_SHIFT 28u +#define SHM3_FW_STATUS_UNKNOWN_31_28_MASK 0xf0000000u +#define GET_SHM3_FW_STATUS_UNKNOWN_31_28(__reg__) (((__reg__) & 0xf0000000) >> 28u) +#define SET_SHM3_FW_STATUS_UNKNOWN_31_28(__val__) (((__val__) << 28u) & 0xf0000000u) + +#define REG_SHM3_FW_FEATURES ((volatile APE_SHM3_H_uint32_t*)0x60223010) /* */ +#define SHM3_FW_FEATURES_NCSI_SHIFT 1u +#define SHM3_FW_FEATURES_NCSI_MASK 0x2u +#define GET_SHM3_FW_FEATURES_NCSI(__reg__) (((__reg__) & 0x2) >> 1u) +#define SET_SHM3_FW_FEATURES_NCSI(__val__) (((__val__) << 1u) & 0x2u) + +#define REG_SHM3_4014 ((volatile APE_SHM3_H_uint32_t*)0x60223014) /* Unknown. */ +#define REG_SHM3_FW_VERSION ((volatile APE_SHM3_H_uint32_t*)0x60223018) /* */ +#define SHM3_FW_VERSION_BUILD_SHIFT 0u +#define SHM3_FW_VERSION_BUILD_MASK 0xffu +#define GET_SHM3_FW_VERSION_BUILD(__reg__) (((__reg__) & 0xff) >> 0u) +#define SET_SHM3_FW_VERSION_BUILD(__val__) (((__val__) << 0u) & 0xffu) +#define SHM3_FW_VERSION_REVISION_SHIFT 8u +#define SHM3_FW_VERSION_REVISION_MASK 0xff00u +#define GET_SHM3_FW_VERSION_REVISION(__reg__) (((__reg__) & 0xff00) >> 8u) +#define SET_SHM3_FW_VERSION_REVISION(__val__) (((__val__) << 8u) & 0xff00u) +#define SHM3_FW_VERSION_MINOR_SHIFT 16u +#define SHM3_FW_VERSION_MINOR_MASK 0xff0000u +#define GET_SHM3_FW_VERSION_MINOR(__reg__) (((__reg__) & 0xff0000) >> 16u) +#define SET_SHM3_FW_VERSION_MINOR(__val__) (((__val__) << 16u) & 0xff0000u) +#define SHM3_FW_VERSION_MAJOR_SHIFT 24u +#define SHM3_FW_VERSION_MAJOR_MASK 0xff000000u +#define GET_SHM3_FW_VERSION_MAJOR(__reg__) (((__reg__) & 0xff000000) >> 24u) +#define SET_SHM3_FW_VERSION_MAJOR(__val__) (((__val__) << 24u) & 0xff000000u) + +#define REG_SHM3_SEG_MESSAGE_BUFFER_OFFSET ((volatile APE_SHM3_H_uint32_t*)0x6022301c) /* Specifies the offset of a scratchpad area, relative to the start of the APE SHM area (i.e., relative to APE_REG(0x4000)). */ +#define REG_SHM3_SEG_MESSAGE_BUFFER_LENGTH ((volatile APE_SHM3_H_uint32_t*)0x60223020) /* Specifies the size of the scratchpad area in bytes. */ +#define REG_SHM3_4024 ((volatile APE_SHM3_H_uint32_t*)0x60223024) /* Unknown. Bootcode related. */ +#define REG_SHM3_4028 ((volatile APE_SHM3_H_uint32_t*)0x60223028) /* Unknown. Bootcode related. */ +#define REG_SHM3_LOADER_COMMAND ((volatile APE_SHM3_H_uint32_t*)0x60223038) /* Command sent when using the the APE loader. Zero once handled. */ +#define SHM3_LOADER_COMMAND_COMMAND_SHIFT 0u +#define SHM3_LOADER_COMMAND_COMMAND_MASK 0xffffffffu +#define GET_SHM3_LOADER_COMMAND_COMMAND(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM3_LOADER_COMMAND_COMMAND(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM3_LOADER_COMMAND_COMMAND_NOP 0x0u +#define SHM3_LOADER_COMMAND_COMMAND_READ_MEM 0x1u +#define SHM3_LOADER_COMMAND_COMMAND_WRITE_MEM 0x2u +#define SHM3_LOADER_COMMAND_COMMAND_CALL 0x3u + + +#define REG_SHM3_LOADER_ARG0 ((volatile APE_SHM3_H_uint32_t*)0x6022303c) /* Argument 0 for the APE loader. */ +#define REG_SHM3_LOADER_ARG1 ((volatile APE_SHM3_H_uint32_t*)0x60223040) /* Argument 1 for the APE loader. */ +#define REG_SHM3_RCPU_SEG_SIG ((volatile APE_SHM3_H_uint32_t*)0x60223100) /* Set to APE_RCPU_MAGIC ('RCPU') by RX CPU. */ +#define SHM3_RCPU_SEG_SIG_SIG_SHIFT 0u +#define SHM3_RCPU_SEG_SIG_SIG_MASK 0xffffffffu +#define GET_SHM3_RCPU_SEG_SIG_SIG(__reg__) (((__reg__) & 0xffffffff) >> 0u) +#define SET_SHM3_RCPU_SEG_SIG_SIG(__val__) (((__val__) << 0u) & 0xffffffffu) +#define SHM3_RCPU_SEG_SIG_SIG_RCPU_MAGIC 0x52435055u + + +#define REG_SHM3_RCPU_SEG_LENGTH ((volatile APE_SHM3_H_uint32_t*)0x60223104) /* Set to 0x34. */ +#define REG_SHM3_RCPU_INIT_COUNT ((volatile APE_SHM3_H_uint32_t*)0x60223108) /* Incremented by RX CPU every boot. */ +#define REG_SHM3_RCPU_FW_VERSION ((volatile APE_SHM3_H_uint32_t*)0x6022310c) /* Set to the bootcode version. e.g. 0x0127 -> v1.39. */ +#define REG_SHM3_RCPU_CFG_FEATURE ((volatile APE_SHM3_H_uint32_t*)0x60223110) /* Set to */ +#define REG_SHM3_RCPU_PCI_VENDOR_DEVICE_ID ((volatile APE_SHM3_H_uint32_t*)0x60223114) /* Set to PCI Vendor/Device ID by S2. */ +#define REG_SHM3_RCPU_PCI_SUBSYSTEM_ID ((volatile APE_SHM3_H_uint32_t*)0x60223118) /* Set to PCI Subsystem Vendor/Subsystem ID by S2. */ +#define REG_SHM3_RCPU_APE_RESET_COUNT ((volatile APE_SHM3_H_uint32_t*)0x6022311c) /* Unknown. Incremented by frobnicating routine. */ +#define REG_SHM3_RCPU_LAST_APE_STATUS ((volatile APE_SHM3_H_uint32_t*)0x60223120) /* Unknown. Written by frobnicating routine. */ +#define REG_SHM3_RCPU_LAST_APE_FW_STATUS ((volatile APE_SHM3_H_uint32_t*)0x60223124) /* Unknown. */ +#define REG_SHM3_RCPU_CFG_HW ((volatile APE_SHM3_H_uint32_t*)0x60223128) /* Set from */ +#define REG_SHM3_RCPU_CFG_HW_2 ((volatile APE_SHM3_H_uint32_t*)0x6022312c) /* Set from */ +#define REG_SHM3_RCPU_CPMU_STATUS ((volatile APE_SHM3_H_uint32_t*)0x60223130) /* Set from */ +#define SHM3_RCPU_CPMU_STATUS_ADDRESS_SHIFT 0u +#define SHM3_RCPU_CPMU_STATUS_ADDRESS_MASK 0xffffu +#define GET_SHM3_RCPU_CPMU_STATUS_ADDRESS(__reg__) (((__reg__) & 0xffff) >> 0u) +#define SET_SHM3_RCPU_CPMU_STATUS_ADDRESS(__val__) (((__val__) << 0u) & 0xffffu) +#define SHM3_RCPU_CPMU_STATUS_ADDRESS_ADDRESS 0x362cu + +#define SHM3_RCPU_CPMU_STATUS_STATUS_SHIFT 16u +#define SHM3_RCPU_CPMU_STATUS_STATUS_MASK 0xffff0000u +#define GET_SHM3_RCPU_CPMU_STATUS_STATUS(__reg__) (((__reg__) & 0xffff0000) >> 16u) +#define SET_SHM3_RCPU_CPMU_STATUS_STATUS(__val__) (((__val__) << 16u) & 0xffff0000u) + +#define REG_SHM3_HOST_SEG_SIG ((volatile APE_SHM3_H_uint32_t*)0x60223200) /* Set to APE_HOST_MAGIC ('HOST') to indicate the section is valid. */ +#define REG_SHM3_HOST_SEG_LEN ((volatile APE_SHM3_H_uint32_t*)0x60223204) /* Set to 0x20. */ +#define REG_SHM3_HOST_INIT_COUNT ((volatile APE_SHM3_H_uint32_t*)0x60223208) /* Incremented by host on every initialization. */ +#define REG_SHM3_HOST_DRIVER_ID ((volatile APE_SHM3_H_uint32_t*)0x6022320c) /* Linux sets this to 0xF0MM_mm00, where M is the major version of Linux and m is the minor version. */ +#define REG_SHM3_HOST_BEHAVIOR ((volatile APE_SHM3_H_uint32_t*)0x60223210) /* */ +#define SHM3_HOST_BEHAVIOR_NO_PHYLOCK_SHIFT 0u +#define SHM3_HOST_BEHAVIOR_NO_PHYLOCK_MASK 0x1u +#define GET_SHM3_HOST_BEHAVIOR_NO_PHYLOCK(__reg__) (((__reg__) & 0x1) >> 0u) +#define SET_SHM3_HOST_BEHAVIOR_NO_PHYLOCK(__val__) (((__val__) << 0u) & 0x1u) + +#define REG_SHM3_HEARTBEAT_INTERVAL ((volatile APE_SHM3_H_uint32_t*)0x60223214) /* In milliseconds. Set to 0 to disable heartbeating. */ +#define REG_SHM3_HEARTBEAT_COUNT ((volatile APE_SHM3_H_uint32_t*)0x60223218) /* */ +#define REG_SHM3_HOST_DRIVER_STATE ((volatile APE_SHM3_H_uint32_t*)0x6022321c) /* */ +#define REG_SHM3_WOL_SPEED ((volatile APE_SHM3_H_uint32_t*)0x60223224) /* */ +#define REG_SHM3_EVENT_STATUS ((volatile APE_SHM3_H_uint32_t*)0x60223300) /* */ +#define SHM3_EVENT_STATUS_DRIVER_EVENT_SHIFT 4u +#define SHM3_EVENT_STATUS_DRIVER_EVENT_MASK 0x10u +#define GET_SHM3_EVENT_STATUS_DRIVER_EVENT(__reg__) (((__reg__) & 0x10) >> 4u) +#define SET_SHM3_EVENT_STATUS_DRIVER_EVENT(__val__) (((__val__) << 4u) & 0x10u) +#define SHM3_EVENT_STATUS_COMMAND_SHIFT 8u +#define SHM3_EVENT_STATUS_COMMAND_MASK 0xff00u +#define GET_SHM3_EVENT_STATUS_COMMAND(__reg__) (((__reg__) & 0xff00) >> 8u) +#define SET_SHM3_EVENT_STATUS_COMMAND(__val__) (((__val__) << 8u) & 0xff00u) +#define SHM3_EVENT_STATUS_COMMAND_STATE_CHANGE 0x5u +#define SHM3_EVENT_STATUS_COMMAND_SCRATCHPAD_READ 0x16u +#define SHM3_EVENT_STATUS_COMMAND_SCRATCHPAD_WRITE 0x17u + +#define SHM3_EVENT_STATUS_STATE_SHIFT 16u +#define SHM3_EVENT_STATUS_STATE_MASK 0x70000u +#define GET_SHM3_EVENT_STATUS_STATE(__reg__) (((__reg__) & 0x70000) >> 16u) +#define SET_SHM3_EVENT_STATUS_STATE(__val__) (((__val__) << 16u) & 0x70000u) +#define SHM3_EVENT_STATUS_STATE_START 0x1u +#define SHM3_EVENT_STATUS_STATE_UNLOAD 0x2u +#define SHM3_EVENT_STATUS_STATE_WOL 0x3u +#define SHM3_EVENT_STATUS_STATE_SUSPEND 0x4u + +#define SHM3_EVENT_STATUS_PENDING_SHIFT 31u +#define SHM3_EVENT_STATUS_PENDING_MASK 0x80000000u +#define GET_SHM3_EVENT_STATUS_PENDING(__reg__) (((__reg__) & 0x80000000) >> 31u) +#define SET_SHM3_EVENT_STATUS_PENDING(__val__) (((__val__) << 31u) & 0x80000000u) + +#define REG_SHM3_PROT_MAGIC ((volatile APE_SHM3_H_uint32_t*)0x60223308) /* This is set to APE_PROT_MAGIC ('PROT') on all functions. If it is 'PROT', the following fields (MAC0_HIGH/LOW) are valid */ +#define REG_SHM3_PROT_MAC0_HIGH ((volatile APE_SHM3_H_uint32_t*)0x60223314) /* High 16 bits of MAC address 0. Only valid if */ +#define REG_SHM3_PROT_MAC0_LOW ((volatile APE_SHM3_H_uint32_t*)0x60223318) /* Low 16 bits of MAC address 0. */ +#define REG_SHM3_NCSI_SIG ((volatile APE_SHM3_H_uint32_t*)0x60223800) /* Set to NCSI_MAGIC ('NCSI') by APE firmware. NOTE: all words in the NCSI section are available in the function 0 SHM area only. */ +#define REG_SHM3_NCSI_BUILD_TIME ((volatile APE_SHM3_H_uint32_t*)0x60223810) /* ASCII string spanning three 32-bit words. Unused trailing bytes are set to zero. */ +#define REG_SHM3_NCSI_BUILD_TIME_2 ((volatile APE_SHM3_H_uint32_t*)0x60223814) /* */ +#define REG_SHM3_NCSI_BUILD_TIME_3 ((volatile APE_SHM3_H_uint32_t*)0x60223818) /* */ +#define REG_SHM3_NCSI_BUILD_DATE ((volatile APE_SHM3_H_uint32_t*)0x6022381c) /* ASCII string spanning three 32-bit words. Unused trailing bytes are set to zero. */ +#define REG_SHM3_NCSI_BUILD_DATE_2 ((volatile APE_SHM3_H_uint32_t*)0x60223820) /* */ +#define REG_SHM3_NCSI_BUILD_DATE_3 ((volatile APE_SHM3_H_uint32_t*)0x60223824) /* */ +#define REG_SHM3_CHIP_ID ((volatile APE_SHM3_H_uint32_t*)0x60223890) /* The APE code copies the contents of Chip ID to this word */ +/** @brief Device SHM Registers, function 3 */ +extern volatile SHM_t SHM3; + + + +#ifdef CXX_SIMULATOR /* Compiling c++ code - uses register wrappers */ +#undef volatile +#endif /* CXX_SIMULATOR */ + +#undef register_container +#undef BITFIELD_BEGIN +#undef BITFIELD_MEMBER +#undef BITFIELD_END + +#endif /* !APE_SHM3_H */ + +/** @} */ |