Difference between revisions of "SUSI"

Revision as of 09:28, 9 June 2022

Introduction

When developers want to write an application that involves hardware access, they have to study the specifications to write the drivers. This is a time-consuming job and requires lots of expertise. Advantech has done all the hard work for our customers with the release of a suite of Software APIs, Application Programming Interfaces, which is a Bridge to Simplify & Enhance H/W & Application Implementation Efficiency. Nowadays, Advantech provides our sample application demos, HW drivers and APIs. The drivers which are keeping in maintenance included Secured & Unified Smart Interface (SUSI) 4.0, 3.02 and iManager 2.0. Only SUSI4 driver is on developing, so we recommend SUSI4 to new customers.

Drivers of APIs

iManager 2.0

Advantech's EC platforms come equipped with iManager, a micro controller that provides embedded features for system integrators. Embedded features have been moved from the OS/BIOS level to the board level, to increase reliability and simplify integration.

SUSI 3.02

SUSI 3.02 provides not only the underlying drivers required but also a rich set of user-friendly, intelligent and integrated interfaces, which speeds development, enhances security and offers add-on value for Advantech platforms. SUSI plays the role of catalyst between developer and solution, and makes Advantech embedded platforms easier and simpler to adopt and operate with customer applications.

SUSI 4.0

SUSI 4.0 driver supports include not only newer SUSI 4.0 APIs, but also the APIs of SUSI 3.02 and iManager 2.0. Therefore, the old customers, who bought SUSI 3.02 or iManager 2.0 before, can install SUSI 4.0 driver with no effort. Customers will enjoy better performance which is SUSI 4.0 driver carries out.

Installation on Linux

1. Installation

Untar the SUSI 4.0 tar.gz file

Change directory to “SUSI4.0.*/Driver” folder and execute "make install "

2. Uninstallation

Change directory to “SUSI4.0.*/Driver” folder and execute "make uninstall "

SUSI Device

SUSI Device is auxiliary library that depend on SUSI library.

Difference between revisions of "SUSI"

Revision as of 09:28, 9 June 2022

Contents

Introduction

Drivers of APIs

iManager 2.0

SUSI 3.02

SUSI 4.0

Installation on Linux

1. Installation

2. Uninstallation

SUSI Device

Document

SUSI4 Sample Code

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 1: / Line 1: @@
-= '''1 Introduction''' =
+<h2>Introduction</h2>
-'''SUSI – A Bridge to Simplify & Enhance H/W & Application Implementation Efficiency'''
+<p>When developers want to write an application that involves hardware access, they have to study the specifications to write the drivers. This is a time-consuming job and requires lots of expertise. Advantech has done all the hard work for our customers with the release of a suite of Software APIs, Application Programming Interfaces, which is <i>a Bridge to Simplify &amp; Enhance H/W &amp; Application Implementation Efficiency</i>. Nowadays, Advantech provides our sample application demos, HW drivers and APIs. The drivers which are keeping in maintenance included Secured &amp; Unified Smart Interface (SUSI) 4.0, 3.02 and iManager 2.0. Only SUSI4 driver is on developing, so we recommend SUSI4 to new customers.</p>
-When developers want to write an application that involves hardware access, they have to study the specifications to write the drivers. This is a time-consuming job and requires lots of expertise.
+== Drivers of APIs ==
-Advantech has done all the hard work for our customers with the release of a suite of Software APIs (Application Programming Interfaces), called '''Secured & Unified Smart Interface''' (SUSI).
+=== iManager 2.0 ===
-SUSI provides not only the underlying drivers required but also a rich set of user-friendly, intelligent and integrated interfaces, which speeds development, enhances security and offers add-on value for Advantech platforms. SUSI plays the role of catalyst between developer and solution, and makes Advantech embedded platforms easier and simpler to adopt and operate with customer applications.
+Advantech's EC platforms come equipped with iManager, a micro controller that provides embedded features for system integrators. Embedded features have been moved from the OS/BIOS level to the board level, to increase reliability and simplify integration.
+=== SUSI 3.02 ===
+SUSI 3.02 provides not only the underlying drivers required but also a rich set of user-friendly, intelligent and integrated interfaces, which speeds development, enhances security and offers add-on value for Advantech platforms. SUSI plays the role of catalyst between developer and solution, and makes Advantech embedded platforms easier and simpler to adopt and operate with customer applications.
-== '''1.1 Functions''' ==
+=== SUSI 4.0 ===
-=== '''1.1.1 GPIO''' ===
+SUSI 4.0 driver supports include not only newer SUSI 4.0 APIs, but also the APIs of SUSI 3.02 and iManager 2.0. Therefore, the old customers, who bought SUSI 3.02 or iManager 2.0 before, can install SUSI 4.0 driver with no effort. Customers will enjoy better performance which is SUSI 4.0 driver carries out.
-[[File:1.1.1 GPIO.png|100x150px|1.1.1 GPIO.png]]
+==== Installation on Linux ====
-General Purpose Input/Output is a flexible parallel interface that allows a variety of custom connections. It supports various Digital I/O devices – input devices like buttons, switches; output devices such as cash drawers, LED lights…etc. And, allows users to monitor the level of signal input or set the output status to switch on/off the device. Our APIs also provided Programmable GPIO and allows developers to dynamically set the GPIO input or output status.
+===== 1. Installation =====
+Untar the SUSI 4.0 tar.gz file
+[[File:SUSI4.0 1.png|500x600px|SUSI4.0_1.png]]
-=== '''1.1.2 SMBus [x86 only and RISC is unavailable]''' ===
+Change directory to “SUSI4.0.*/Driver” folder and execute "make install "
-[[File:1.1.2 SMBus.png|100x150px|1.1.2 SMBus.png]]
+[[File:SUSI4.0 3.png|500x600px|SUSI4.0_3.png]]
-SMBus is the System Management Bus defined by Intel Corporation in 1995. It is used in personal computers and servers for low-speed system management communications. Today, SMBus is used in all types of embedded systems. The SMBus APIs allows a developer to interface a platform to a downstream embedded system environment and transfer serial messages using the SMBus protocols, allowing multiple simultaneous device control.
+===== 2. Uninstallation =====
+Change directory to “SUSI4.0.*/Driver” folder and execute "make uninstall "
+[[File:SUSI4.0 5.png|500x600px|SUSI4.0_5.png]]
-=== '''1.1.3 I<sup>2</sup>C''' ===
+=== SUSI Device ===
-[[File:1.1.3 i2c.png|100x150px|1.1.3 i2c.png]]
+SUSI Device is auxiliary library that depend on SUSI library.
-I<sup>2</sup>C is a bi-directional two wire bus that was developed by Philips for use in their televisions in the 1980s. Today, I<sup>2</sup>C is used in all types of embedded systems. The I<sup>2</sup>C API allows a developer to interface a platform to a downstream embedded system environment and transfer serial messages using the I<sup>2</sup>C protocols, allowing multiple simultaneous device control.
+== Document ==
+*[[Media:IManager_2.0_Software_API_user_manual_ed.1.pdf|<big><big>''iManger 2.0 API User Manual''</big></big>]]
+*[[Media:SUSI_V3.02_API_UserManual.pdf|<big><big>''SUSI 3.02 API User Manual''</big></big>]]
+*[[Media:SUSI4_User_Manual.pdf|<big><big>''SUSI 4.0 API User Manual''</big></big>]]
+*[[Media:SusiDevice_User_Manual.pdf|<big><big>''SUSI Device API User Manual''</big></big>]]
+*[[SW_Service/API/SUSI4.0_USER_MANUAL|<big><big>''SUSI 4.0 User Manual''</big></big>]]
+== SUSI4 Sample Code ==
-=== '''1.1.4 Watchdog''' ===
+*[https://wesstorage.blob.core.windows.net/eiss/SUSI4_Demo_C.zip <big><big>''SUSI 4 Demo Utility in C''</big></big>]
+*[https://wesstorage.blob.core.windows.net/eiss/SUSI4_Demo_C-Sharp.zip <big><big>''SUSI 4 Demo Utility in C#''</big></big>]
-[[File:1.1.4 watchdog.png|100x150px|1.1.4 watchdog.png]]
-A watchdog timer (WDT) is a device or electronic card that performs a specific operation after a certain period of time if something goes wrong with an electronic system and the system does not recover on its own.
-A watchdog timer can be programmed to perform a warm boot (restarting the system) after a certain number of seconds during which a program or computer fails to respond following the most recent mouse click or keyboard action.
-=== '''1.1.5 Hardware Monitor&nbsp;[x86 only and RISC is limited in some features]''' ===
-[[File:1.1.5 HardwareMonitor 1.png|100x150px|1.1.5 HardwareMonitor 1.png]] &nbsp; [[File:1.1.5 HardwareMonitor 2.png|100x150px|1.1.5 HardwareMonitor 2.png]]
-The Hardware Monitor (HWM) APIs is a system health supervision API that inspects certain condition indexes, such as smart fan, fan speed, temperature, current, case open and voltage.
-=== '''1.1.6 Backlight Control''' ===
-[[File:1.1.6 Backlight 1.png|100x150px|1.1.6 Backlight 1.png]] &nbsp; [[File:1.1.6 Backlight 2.png|100x150px|1.1.6 Backlight 2.png]]
-The Backlight Control APIs allows a developer to interface platform to easily control brightness through PWM and backlight on/off.
-=== '''1.1.7 Storage&nbsp;[x86 only and RISC is unavailable]''' ===
-[[File:1.1.7 Storage.png|100x150px|1.1.7 Storage.png]]
-Storage is a non-volatile storage, the storage APIs allows a developer to access storage information, read/write data to storage and lock/unlock data area (same like write protection) by a key.
-=== '''1.1.8 Thermal Protection&nbsp;[x86 only and RISC is unavailable]''' ===
-[[File:1.1.8 Thermal 1.png|100x150px|1.1.8 Thermal 1.png]] &nbsp; [[File:1.1.8 Thermal 2.png|100x150px|1.1.8 Thermal 2.png]]
-Thermal Protection can select a thermal source to monitor. When source temperature reach the limit, SUSI can act protect function to protect system.
-== '''1.2 Benefits''' ==
-*'''Faster Time to Market'''
-:SUSI's unified API helps developers write applications to control the hardware without knowing the hardware specs of the chipsets and driver architecture.
-*'''Reduced Project Effort'''
-:When customers have their own devices connected to the onboard bus, they can either: study the data sheet and write the driver & API from scratch, or they can use SUSI to start the integration with a 50% head start. Developers can reference the sample program on&nbsp;the CD to see and learn more about the software development environment.
-*'''Enhances Hardware Platform Reliability'''
-:SUSI provides a trusted custom ready solution which combines chipset and library function support, controlling application development through SUSI enhances reliability and brings peace of mind.
-*'''Flexible Upgrade Possibilities'''
-:SUSI supports an easy upgrade solution for customers. Customers just need to install the new version SUSI that supports the new functions.
-*'''Backward compatibility'''
-:Support SUSI 3.0, iManager 2.0 and EAPI 1.0 interface. Customers don’t need to change any APIs in their applications.
-== '''1.3 Environment Requirements''' ==
-=== '''1.3.1Operating Systems''' ===
-::Windows XP Embedded
-::Windows XP 32-bit
-::Windows 7 (x86 / x64)
-::WES7 (x86 / x64)
-::Windows 8 Desktop (x86 / x64)
-::Windows 10 (x86 / x64)
-::Windows CE 5 / 6 / 7
-::RISC Yocto 2.1
-::Linux (Project based, request from your local FAE)
-::Android (Project based, request from your local FAE)
-::QNX (Project based, request from your local FAE)
-::VxWorks (Project based, request from your local FAE)
-&nbsp;
-= '''2 SUSI Definition''' =
-Susi4.h file includes the API declaration, constants and flags that are required for programming.
-== '''2.1 Status Codes''' ==
-All SUSI API functions immediately return a status code from a common list of possible errors. Any function may return any of the defined status codes. See the Appendix for more detailed information.
-&nbsp;
- #define SUSI_STATUS_NOT_INITIALIZED					&nbsp;&nbsp; &nbsp;0xFFFFFFFF
-:'''Description'''
-::The SUSI API library is not yet or unsuccessfully initialized. SusiLibInitialize needs to be called prior to the first access of any other SUSI API functions.
-:'''Actions'''
-::Call SusiLibInitialize.
- #define SUSI_STATUS_INITIALIZED						&nbsp;&nbsp; &nbsp;0xFFFFFFFE
-:'''Description'''
-::Library is initialized.
-:'''Actions'''
-::None.
- #define SUSI_STATUS_ALLOC_ERROR						&nbsp;&nbsp; &nbsp;0xFFFFFFFD
-:'''Description'''
-::Memory Allocation Error.
-:'''Actions'''
-::Free memory and try again.
- #define SUSI_STATUS_DRIVER_TIMEOUT						0xFFFFFFFC
-:'''Description'''
-::Time out in driver. This is Normally caused by hardware/software semaphore timeout.
-:'''Actions'''
-::Retry.
- #define SUSI_STATUS_INVALID_PARAMETER					0xFFFFFEFF
-:'''Description'''
-::One or more of the SUSI API functions call parameters are out of defined range.
-:'''Actions'''
-::Verify Function Parameters.
- #define SUSI_STATUS_INVALID_BLOCK_ALIGNMENT			0xFFFFFEFE
-:'''Description'''
-::The Block Alignment is incorrect.
-:'''Actions'''
-::Use Inputs and Outputs to correctly select input and outputs.
- #define SUSI_STATUS_INVALID_BLOCK_LENGTH				0xFFFFFEFD
-:'''Description'''
-::This means that the Block length is too long.
-:'''Actions'''
-::Use Alignment Capabilities information to correctly align write access.
- #define SUSI_STATUS_INVALID_DIRECTION					0xFFFFFEFC
-:'''Description'''
-::The current Direction Argument attempts to set GPIOs to a unsupported direction. I.E. Setting GPI to Output.
-:'''Actions'''
-::Use Inputs and Outputs to correctly select input and outputs.
- #define SUSI_STATUS_INVALID_BITMASK					0xFFFFFEFB
-:'''Description'''
-::The Bitmask Selects bits/GPIOs which are not supported for the current ID.
-:'''Actions'''
-::Use Inputs and Outputs to probe supported bits.
- #define SUSI_STATUS_RUNNING							0xFFFFFEFA
-:'''Description'''
-::Watchdog timer already started.
-:'''Actions'''
-::Call SusiWDogStop before retrying.
- #define SUSI_STATUS_UNSUPPORTED						0xFFFFFCFF
-:'''Description'''
-::This function or ID is not supported at the actual hardware environment.
-:'''Actions'''
-::None.
- #define SUSI_STATUS_NOT_FOUND							0xFFFFFBFF
-:'''Description'''
-::Selected device was not found
-:'''Actions'''
-::None.
- #define SUSI_STATUS_TIMEOUT							0xFFFFFBFE
-:'''Description'''
-::Device has no response.
-:'''Actions'''
-::None.
- #define SUSI_STATUS_BUSY_COLLISION						0xFFFFFBFD
-:'''Description'''
-::The selected device or ID is busy or a data collision is detected.
-:'''Actions'''
-::Retry.
- #define SUSI_STATUS_READ_ERROR							0xFFFFFAFF
-:'''Description'''
-::An error is detected during a read operation.
-:'''Actions'''
-::Retry.
- #define SUSI_STATUS_WRITE_ERROR						0xFFFFFAFE
-:'''Description'''
-::An error is detected during a write operation.
-:'''Actions'''
-::Retry.
- #define SUSI_STATUS_MORE_DATA							0xFFFFF9FF
-:'''Description'''
-::The amount of available data exceeds the buffer size. Storage buffer overflow was prevented. Read count was larger than the defined buffer length.
-:'''Actions'''
-::Either increase the buffer size or reduce the block length.
- #define SUSI_STATUS_ERROR								0xFFFFF0FF
-:'''Description'''
-::Generic error message. No further error details are available.
-:'''Actions'''
-::None.
- #define SUSI_STATUS_SUCCESS					0
-:'''Description'''
-::The operation is successful.
-:'''Actions'''
-::None.
-== '''2.2 ID''' ==
- #define SUSI_ID_UNKNOWN					0xFFFFFFFF
-:'''Description'''
-::Undefined/Unknown ID
- #define SUSI_ID_BOARD_MANUFACTURER_STR			0
- #define SUSI_ID_BOARD_NAME_STR				1
- #define SUSI_ID_BOARD_REVISION_STR			2
- #define SUSI_ID_BOARD_SERIAL_STR			3
- #define SUSI_ID_BOARD_BIOS_REVISION_STR			4
- #define SUSI_ID_BOARD_HW_REVISION_STR			5
- #define SUSI_ID_BOARD_PLATFORM_TYPE_STR			6
- #define SUSI_ID_BOARD_EC_FW_STR				7
-:'''Description'''
-::Board information string ID, use in SusiBoardGetStringA.
- #define SUSI_ID_GET_SPEC_VERSION&nbsp				0x00000000
- #define SUSI_ID_BOARD_BOOT_COUNTER_VAL				0x00000001
- #define SUSI_ID_BOARD_RUNNING_TIME_METER_VAL			0x00000002
- #define SUSI_ID_BOARD_PNPID_VAL					0x00000003
- #define SUSI_ID_BOARD_PLATFORM_REV_VAL				0x00000004
- #define SUSI_ID_BOARD_DRIVER_VERSION_VAL			0x00010000
- #define SUSI_ID_BOARD_LIB_VERSION_VAL				0x00010001
- #define SUSI_ID_BOARD_FIRMWARE_VERSION_VAL			0x00010002
-:'''Description'''
-::Board information value ID, use in SusiBoardGetValue.
- #define SUSI_ID_HWM_TEMP_CPU					0x00020000
- #define SUSI_ID_HWM_TEMP_CHIPSET				0x00020001
- #define SUSI_ID_HWM_TEMP_SYSTEM					0x00020002
- #define SUSI_ID_HWM_TEMP_CPU2					0x00020003
- #define SUSI_ID_HWM_TEMP_OEM0					0x00020004
- #define SUSI_ID_HWM_TEMP_OEM1					0x00020005
- #define SUSI_ID_HWM_TEMP_OEM2					0x00020006
- #define SUSI_ID_HWM_TEMP_OEM3					0x00020007
- #define SUSI_ID_HWM_TEMP_OEM4					0x00020008
- #define SUSI_ID_HWM_TEMP_OEM5					0x00020009
-:'''Description'''
-::Board temperature value ID, use in SusiBoardGetValue.
- #define SUSI_ID_HWM_VOLTAGE_VCORE				0x00021000
- #define SUSI_ID_HWM_VOLTAGE_VCORE2				0x00021001
- #define SUSI_ID_HWM_VOLTAGE_2V5					0x00021002
- #define SUSI_ID_HWM_VOLTAGE_3V3					0x00021003
- #define SUSI_ID_HWM_VOLTAGE_5V					0x00021004
- #define SUSI_ID_HWM_VOLTAGE_12V					0x00021005
- #define SUSI_ID_HWM_VOLTAGE_5VSB				0x00021006
- #define SUSI_ID_HWM_VOLTAGE_3VSB				0x00021007
- #define SUSI_ID_HWM_VOLTAGE_VBAT				0x00021008
- #define SUSI_ID_HWM_VOLTAGE_5NV					0x00021009
- #define SUSI_ID_HWM_VOLTAGE_12NV				0x0002100A
- #define SUSI_ID_HWM_VOLTAGE_VTT					0x0002100B
- #define SUSI_ID_HWM_VOLTAGE_24V					0x0002100C
- #define SUSI_ID_HWM_VOLTAGE_DC					0x0002100D
- #define SUSI_ID_HWM_VOLTAGE_DCSTBY				0x0002100E
- #define SUSI_ID_HWM_VOLTAGE_OEM3				0x0002100F
- #define SUSI_ID_HWM_VOLTAGE_OEM0				0x00021010
- #define SUSI_ID_HWM_VOLTAGE_OEM1				0x00021011
- #define SUSI_ID_HWM_VOLTAGE_OEM2				0x00021012
- #define SUSI_ID_HWM_VOLTAGE_OEM3				0x00021013
- #define SUSI_ID_HWM_VOLTAGE_1V05				0x00021014
- #define SUSI_ID_HWM_VOLTAGE_1V5					0x00021015
- #define SUSI_ID_HWM_VOLTAGE_1V8					0x00021016
-:'''Description'''
-::Board voltage value ID, use in SusiBoardGetValue.
- #define SUSI_ID_HWM_FAN_CPU					0x00022000
- #define SUSI_ID_HWM_FAN_SYSTEM					0x00022001
- #define SUSI_ID_HWM_FAN_CPU2					0x00022002
- #define SUSI_ID_HWM_FAN_OEM0					0x00022003
- #define SUSI_ID_HWM_FAN_OEM1					0x00022004
- #define SUSI_ID_HWM_FAN_OEM2					0x00022005
- #define SUSI_ID_HWM_FAN_OEM3					0x00022006
- #define SUSI_ID_HWM_FAN_OEM4					0x00022007
- #define SUSI_ID_HWM_FAN_OEM5					0x00022008
- #define SUSI_ID_HWM_FAN_OEM6					0x00022009
-:'''Description'''
-::Board fan speed value ID, use in SusiBoardGetValue and Smart Fan Functions.
- #define SUSI_ID_HWM_CURRENT_OEM0					0x00023000
- #define SUSI_ID_HWM_CURRENT_OEM1					0x00023001
- #define SUSI_ID_HWM_CURRENT_OEM2					0x00023002
-:'''Description'''
-::Board current value ID, use in SusiBoardGetValue.
- #define SUSI_ID_SMBUS_SUPPORTED					0x00030000
- #define SUSI_ID_I2C_SUPPORTED					0x00030100
-:'''Description'''
-::Board supported information value ID, use in SusiBoardGetValue.
- #define SUSI_ID_SMBUS_EXTERNAL					0
- #define SUSI_ID_SMBUS_OEM0					1
- #define SUSI_ID_SMBUS_OEM1					2
- #define SUSI_ID_SMBUS_OEM2					3
- #define SUSI_ID_SMBUS_OEM3					4
-:'''Description'''
-::SMBus device ID, use in SMBus Functions.
- #define SUSI_ID_I2C_EXTERNAL					0
- #define SUSI_ID_I2C_OEM0					1
- #define SUSI_ID_I2C_OEM1					2
- #define SUSI_ID_I2C_OEM2					3
-:'''Description'''
-::I<sup>2</sup>C device ID, use in I2C Functions.
- #define SUSI_ID_GPIO(GPIO_NUM)					(GPIO_NUM)
- #define SUSI_ID_GPIO_BANK(BANK_NUM)					(0x00010000 + BANK_NUM)
-:'''Description'''
-::GPIO device ID, use in GPIO Functions.
- #define SUSI_ID_BACKLIGHT_1					0
- #define SUSI_ID_BACKLIGHT_2					1
- #define SUSI_ID_BACKLIGHT_3					2
-:'''Description'''
-::Backlight device ID, use in Backlight Functions.
- #define SUSI_ID_STORAGE_STD					0x00000000
- #define SUSI_ID_STORAGE_OEM0					0x00000001
- #define SUSI_ID_STORAGE_OEM1					0x00000002
-:'''Description'''
-::Storage device ID, use in Storage Functions.
- #define SUSI_ID_THERMAL_PROTECT_1					0
- #define SUSI_ID_THERMAL_PROTECT_2					1
- #define SUSI_ID_THERMAL_PROTECT_3					2
- #define SUSI_ID_THERMAL_PROTECT_4					3
-:'''Description'''
-::Thermal protection device ID, use in Thermal Protection Functions
- #define SUSI_ID_WATCHDOG_1					0
- #define SUSI_ID_WATCHDOG_2					1
- #define SUSI_ID_WATCHDOG_3					2
-:'''Description'''
-::Watchdog device ID, use in Watchdog Functions.
-== '''2.3 Item ID''' ==
- #define SUSI_ID_I2C_MAXIMUM_BLOCK_LENGTH			0x00000000
-:'''Description'''
-::Watchdog capabilities item ID, use in SusiI2CGetCaps.
- #define SUSI_ID_GPIO_INPUT_SUPPORT				0x00000000
- #define SUSI_ID_GPIO_OUTPUT_SUPPORT				0x00000001
-:'''Description'''
-::GPIO capabilities item ID, use in SusiGPIOGetCaps.
- #define SUSI_ID_VGA_BRIGHTNESS_MAXIMUM				0x00010000
- #define SUSI_ID_VGA_BRIGHTNESS_MINIMUM				0x00010001
-:'''Description'''
-::VGA capabilities item ID, use in SusiVgaGetCaps.
- #define SUSI_ID_STORAGE_TOTAL_SIZE				0x00000000
- #define SUSI_ID_STORAGE_BLOCK_SIZE				0x00000001
- #define SUSI_ID_STORAGE_LOCK_STATUS				0x00010000
- #define SUSI_ID_STORAGE_PSW_MAX_LEN				0x00010000
-:'''Description'''
-::Storage capabilities item ID, use in SusiStorageGetCaps.
- #define SUSI_ID_WDT_SUPPORT_FLAGS				0x00000000
- #define SUSI_ID_WDT_DELAY_MAXIMUM				0x00000001
- #define SUSI_ID_WDT_DELAY_MINIMUM				0x00000002
- #define SUSI_ID_WDT_EVENT_MAXIMUM				0x00000003
- #define SUSI_ID_WDT_EVENT_MINIMUM				0x00000004
- #define SUSI_ID_WDT_RESET_MAXIMUM				0x00000005
- #define SUSI_ID_WDT_RESET_MINIMUM				0x00000006
- #define SUSI_ID_WDT_UNIT_MINIMUM				0x0000000F
- #define SUSI_ID_WDT_DELAY_TIME					0x00010001
- #define SUSI_ID_WDT_EVENT_TIME					0x00010002
- #define SUSI_ID_WDT_RESET_TIME					0x00010003
- #define SUSI_ID_WDT_EVENT_TYPE					0x00010004
-:'''Description'''
-::Watchdog capabilities item ID, use in SusiWDogGetCaps.
- #define SUSI_ID_FC_CONTROL_SUPPORT_FLAGS			0x00000000
- #define SUSI_ID_FC_AUTO_SUPPORT_FLAGS				0x00000001
-:'''Description'''
-::Fan control capabilities item ID, use in SusiFanControlGetCaps.
- #define SUSI_ID_TP_EVENT_SUPPORT_FLAGS				0x00000000
- #define SUSI_ID_TP_EVENT_TRIGGER_MAXIMUM			0x00000001
- #define SUSI_ID_TP_EVENT_TRIGGER_MINIMUM			0x00000002
- #define SUSI_ID_TP_EVENT_CLEAR_MAXIMUM				0x00000003
- #define SUSI_ID_TP_EVENT_CLEAR_MINIMUM				0x00000004
-:'''Description'''
-::Thermal protection capabilities item ID, use in SusiThermalProtectionGetCaps.
-= '''3 SUSI API''' =
-The SUSI APIs provide functions to control ADVANTECH platforms. SUSI API functions are based on a dynamic library. SUSI API can be implemented in various other programming languages.
-== '''3.1 Initialization Functions''' ==
-=== '''3.1.1 SusiLibInitialize''' ===
- uint32_t SUSI_API SusiLibInitialize(void)
-:'''Description:'''
-::General initialization of the SUSI API. Prior to calling any SUSI API functions, the library needs to be initialized by calling this function. The status code for all SUSI API function will be SUSI_STATUS_NOT_INITIALIZED unless this function is called.
-:'''Parameters:'''
-::None
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:255px;" |
-'''Condition'''
-| style="width:340px;" |
-'''Return Value'''
-|-
-| style="width:255px;" |
-Library initialized
-| style="width:340px;" |
-SUSI_STATUS_INITIALIZED
-|-
-| style="width:255px;" |
-Fail
-| style="width:340px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:255px;" |
-Success
-| style="width:340px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.1.2 SusiLibUninitialize''' ===
- uint32_t SUSI_API SusiLibUninitialize(void)
-:'''Description:'''
-::General function to uninitialize the SUSI API library that should be called before program exit.
-:'''Parameters:'''
-::None
-:'''Return Status Code:'''<br/>
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:255px;" |
-'''Condition'''
-| style="width:340px;" |
-'''Return Value'''
-|-
-| style="width:255px;" |
-Library uninitialized
-| style="width:340px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:255px;" |
-Success
-| style="width:340px;" |
-SUSI_STATUS_SUCCESS
-|}
-== '''3.2 Information Functions''' ==
-=== '''3.2.1 SusiBoardGetValue''' ===
- uint32_t SUSI_API SusiBoardGetValue(uint32_t Id, uint32_t *pValue)
-:'''Description:'''
-::Getting information about the hardware platform in value format.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target value. See Table 1 to Table 5.
-::'''pValue'''
-:::Pointer to a buffer that receives the value's data.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:255px;" |
-'''Condition'''
-| style="width:340px;" |
-'''Return Value'''
-|-
-| style="width:255px;" |
-Library uninitialized
-| style="width:340px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:255px;" |
-pValue==NULL
-| style="width:340px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:255px;" |
-Unknown Id
-| style="width:340px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:255px;" |
-Device unsupported
-| style="width:340px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:255px;" |
-Success
-| style="width:340px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table 1 Board information value ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:317px;" |
-'''Id'''
-| style="width:197px;" |
-'''Description'''
-| style="width:85px;" |
-'''Unit'''
-|-
-| style="width:317px;" |
-SUSI_ID_GET_SPEC_VERSION
-| style="width:197px;" |
-API Specification Version
-| style="width:85px;" |
-&nbsp;
-|-
-| style="width:317px;" |
-SUSI_ID_BOARD_BOOT_COUNTER_VAL
-| style="width:197px;" |
-Boot Counter
-| style="width:85px;" |
-boot
-|-
-| style="width:317px;" |
-SUSI_ID_BOARD_RUNNING_TIME_METER_VAL
-| style="width:197px;" |
-Running Time Meter
-| style="width:85px;" |
-hour
-|-
-| style="width:317px;" |
-SUSI_ID_BOARD_PNPID_VAL
-| style="width:197px;" |
-Board Vendor PNPID
-| style="width:85px;" |
-&nbsp;
-|-
-| style="width:317px;" |
-SUSI_ID_BOARD_PLATFORM_REV_VAL
-| style="width:197px;" |
-Platform revision
-| style="width:85px;" |
-&nbsp;
-|-
-| style="width:317px;" |
-SUSI_ID_BOARD_DRIVER_VERSION_VAL
-| style="width:197px;" |
-Driver version
-| style="width:85px;" |
-&nbsp;
-|-
-| style="width:317px;" |
-SUSI_ID_BOARD_LIB_VERSION_VAL
-| style="width:197px;" |
-Library version
-| style="width:85px;" |
-&nbsp;
-|-
-| style="width:317px;" |
-SUSI_ID_BOARD_FIRMWARE_VERSION_VAL
-| style="width:197px;" |
-Firmware version
-| style="width:85px;" |
-&nbsp;
-|}
-:'''Table 2 Board voltage value ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:317px;" |
-'''Id'''
-| style="width:197px;" |
-'''Description'''
-| style="width:85px;" |
-'''Unit'''
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_VCORE
-| style="width:197px;" |
-CPU Core voltage
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_VCORE2&nbsp;
-| style="width:197px;" |
-Second CPU Core voltage
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_2V5
-| style="width:197px;" |
-.5V
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_3V3
-| style="width:197px;" |
-.3V
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_5V
-| style="width:197px;" |
-V
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_12V
-| style="width:197px;" |
-V
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_5VSB&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-| style="width:197px;" |
-V Standby
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_3VSB
-| style="width:197px;" |
-V Standby
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_VBAT
-| style="width:197px;" |
-CMOS Battery voltage
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_5NV
-| style="width:197px;" |
--5V
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_12NV
-| style="width:197px;" |
--12V
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_VTT
-| style="width:197px;" |
-DIMM voltage
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_24V
-| style="width:197px;" |
-V
-| style="width:85px;" |
-millivolt
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_VOLTAGE_OEM0~3
-| style="width:197px;" |
-Other voltages
-| style="width:85px;" |
-millivolt
-|}
-:'''Table 3 Board temperature value ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:317px;" |
-'''Id'''
-| style="width:197px;" |
-'''Description'''
-| style="width:85px;" |
-'''Unit'''
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_TEMP_CPU
-| style="width:197px;" |
-CPU temperature
-| style="width:85px;" |
-.1 Kelvin
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_TEMP_CHIPSET
-| style="width:197px;" |
-Chipset temperature
-| style="width:85px;" |
-.1 Kelvin
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_TEMP_SYSTEM
-| style="width:197px;" |
-System temperature
-| style="width:85px;" |
-.1 Kelvin
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_TEMP_CPU2
-| style="width:197px;" |
-CPU2 temperature
-| style="width:85px;" |
-.1 Kelvin
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_TEMP_OEM0~5
-| style="width:197px;" |
-Other temperatures
-| style="width:85px;" |
-.1 Kelvin
-|}
-:'''Table 4 Board fan speed value ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:317px;" |
-'''Id'''
-| style="width:197px;" |
-'''Description'''
-| style="width:85px;" |
-'''Unit'''
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_FAN_CPU
-| style="width:197px;" |
-CPU fan speed
-| style="width:85px;" |
-RPM
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_FAN_SYSTEM
-| style="width:197px;" |
-System fan speed
-| style="width:85px;" |
-RPM
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_FAN_CPU2
-| style="width:197px;" |
-Second CPU fan speed
-| style="width:85px;" |
-RPM
-|-
-| style="width:317px;" |
-SUSI_ID_HWM_FAN_OEM0~6
-| style="width:197px;" |
-Other fans
-| style="width:85px;" |
-RPM
-|}
-:'''Table 5 Board support information value ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:316px;" |
-'''Id'''
-| style="width:283px;" |
-'''Description'''
-|-
-| style="width:316px;" |
-SUSI_ID_SMBUS_SUPPORTED
-| style="width:283px;" |
-Mask flags:
-SUSI_SMBUS_EXTERNAL_SUPPORTED
-SUSI_SMBUS_OEM0_SUPPORTED
-SUSI_SMBUS_OEM1_SUPPORTED
-SUSI_SMBUS_OEM2_SUPPORTED
-SUSI_SMBUS_OEM3_SUPPORTED
-|-
-| style="width:316px;" |
-SUSI_ID_I2C_SUPPORTED
-| style="width:283px;" |
-Mask flags:
-SUSI_ I2C_EXTERNAL_SUPPORTED
-SUSI_ I2C_OEM0_SUPPORTED
-SUSI_ I2C_OEM1_SUPPORTED
-SUSI_ I2C_OEM2_SUPPORTED
-|}
-=== '''3.2.2 SusiBoardGetStringA''' ===
- uint32_t SUSI_API SusiBoardGetStringA(uint32_t Id, char *pBuffer, uint32_t *pBufLen)
-:'''Description:'''
-::Text information about the hardware platform.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target string. See Table 6.
-::'''pBuffer'''
-:::Pointer to a buffer that receives the value's data.
-::'''pBufLen'''
-:::Pointer to a variable that specifies the size, in bytes, of the buffer pointed to by the pBuffer parameter. When the function returns, this variable contains the size of the data copied to pBuffer including the terminating null character.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBufLen==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-pBufLen!=NULL&&*pBufLen&&pBuffer==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-strlength + 1 > *pBufLen
-| style="width:313px;" |
-SUSI_STATUS_MORE_DATA
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table 6 Board information string ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:316px;" |
-'''Id'''
-| style="width:283px;" |
-'''Description'''
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_MANUFACTURER_STR
-| style="width:283px;" |
-Board Manufacturer Name
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_NAME_STR
-| style="width:283px;" |
-Board Name
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_REVISION_STR
-| style="width:283px;" |
-Board Revision
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_SERIAL_STR
-| style="width:283px;" |
-Board Serial Number
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_BIOS_REVISION_STR
-| style="width:283px;" |
-Board BIOS Revision
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_HW_REVISION_STR
-| style="width:283px;" |
-Hardware Revision
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_PLATFORM_TYPE_STR
-| style="width:283px;" |
-Platform type
-|-
-| style="width:316px;" |
-SUSI_ID_BOARD_EC_FW_STR
-| style="width:283px;" |
-EC FW
-|}
-== '''3.3 Backlight Functions''' ==
-This function sub set facilitates backlight control for Integrated flat panel displays, typically LVDS.
-:'''Table 7 Backlight ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:316px;" |
-'''Id'''
-| style="width:283px;" |
-'''Description'''
-|-
-| style="width:316px;" |
-SUSI_ID_BACKLIGHT_1
-| style="width:283px;" |
-Backlight Local Flat Panel 1
-|-
-| style="width:316px;" |
-SUSI_ID_BACKLIGHT_2
-| style="width:283px;" |
-Backlight Local Flat Panel 2
-|-
-| style="width:316px;" |
-SUSI_ID_BACKLIGHT_3
-| style="width:283px;" |
-Backlight Local Flat Panel 3
-|}
-:'''Table 8 Backlight Enable Values'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:316px;" |
-'''Name'''
-| style="width:283px;" |
-'''Description'''
-|-
-| style="width:316px;" |
-SUSI_BACKLIGHT_SET_ON
-| style="width:283px;" |
-Signifies that the Backlight be Enabled
-|-
-| style="width:316px;" |
-SUSI_BACKLIGHT_SET_OFF
-| style="width:283px;" |
-Signifies that the Backlight be Disabled
-|}
-=== '''3.3.1 SusiVgaGetCaps''' ===
- uint32_t SUSI_API SusiVgaGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue);
-:'''Description:'''
-::Gets VGA capabilities.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''ItemId'''
-:::Selects target capability. See Table 9.
-::'''pValue'''
-:::Pointer to a buffer that receives the target capability.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pValue==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id or ItemId
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table 9 VGA capabilities item Id'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Item Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_VGA_BRIGHTNESS_MAXIMUM
-| style="width:302px;" |
-Maximum backlight value
-|-
-| style="width:297px;" |
-SUSI_ID_VGA_BRIGHTNESS_MINIMUM
-| style="width:302px;" |
-Minimum backlight value
-|}
-=== '''3.3.2 SusiVgaGetBacklightEnable''' ===
- uint32_t SUSI_API SusiVgaGetBacklightEnable(uint32_t Id, uint32_t *pEnable)
-:'''Description:'''
-::Gets current Backlight Enable state for specified Flat Panel.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''pEnable'''
-:::Pointer to a buffer that receives the current backlight enable state. See Table 8.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pEnable==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.3.3 SusiVgaSetBacklightEnable''' ===
- uint32_t SUSI_API SusiVgaSetBacklightEnable(uint32_t Id, uint32_t Enable)
-:'''Description:'''
-::Enables or disable the backlight of the selected flat panel display
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''Enable'''
-:::Backlight Enable options. See Table 8.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.3.4 SusiVgaGetBacklightBrightness''' ===
- uint32_t SUSI_API SusiVgaGetBacklightBrightness(uint32_t Id, uint32_t *pBright)
-:'''Description:'''
-::Reads the current brightness of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''pBright'''
-:::Pointer to a buffer that receives the current backlight brightness value.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBright==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.3.5 SusiVgaSetBacklightBrightness''' ===
- uint32_t SUSI_API SusiVgaSetBacklightBrightness(uint32_t Id, uint32_t Bright)
-:'''Description:'''
-::Reads the current brightness of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''Bright'''
-:::Backlight Brightness value.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Bright > MAX value &#124;&#124; Bright < MIN value
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.3.6 SusiVgaGetBacklightLevel''' ===
- uint32_t SUSI_API SusiVgaGetBacklightLevel(uint32_t Id, uint32_t *pLevel)
-:'''Description:'''
-::Reads the current brightness level of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''pLevel'''
-:::Pointer to a buffer that receives the current backlight brightness level. See Table 10.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pLevel==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table 10 Brightness level range definition'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Name'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_BACKLIGHT_LEVEL_MAXIMUM
-| style="width:302px;" |
-Maximum backlight level is 9
-|-
-| style="width:297px;" |
-SUSI_BACKLIGHT_LEVEL_MINIMUM
-| style="width:302px;" |
-Minimum backlight level is 0
-|}
-=== '''3.3.7 SusiVgaSetBacklightLevel''' ===
- uint32_t SUSI_API SusiVgaSetBacklightLevel(uint32_t Id, uint32_t Level)
-:'''Description:'''
-::Sets the brightness level of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''Level'''
-:::Backlight Brightness level. See Table 10.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Level>SUSI_BACKLIGHT_LEVEL_MAXIMUM
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.3.8 SusiVgaGetPolarity''' ===
- uint32_t SUSI_API SusiVgaGetPolarity(uint32_t Id, uint32_t *pPolarity)
-:'''Description:'''
-::Reads the current backlight polarity of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See Table 7.
-::'''pPolarity'''
-:::Pointer to a buffer that receives the current backlight polarity. See Table 11.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pPolarity==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table 11 Brightness polarity definition'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Name'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_BACKLIGHT_POLARITY_ON
-| style="width:302px;" |
-Backlight signal polarity ON&nbsp;
-|-
-| style="width:297px;" |
-SUSI_BACKLIGHT_ POLARITY_OFF
-| style="width:302px;" |
-Backlight signal polarity OFF
-|}
-=== '''3.3.9 SusiVga'''SetPolarity ===
- uint32_t SUSI_API SusiVgaSetPolarity(uint32_t Id, uint32_t Polarity)
-:'''Description:'''
-::Sets the polarity of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 7'''.
-::'''Polarity'''
-:::Polarity state. See '''Table 11'''.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.3.10 SusiVgaGet'''Frequency ===
- uint32_t SUSI_API SusiVgaGetFrequency(uint32_t Id, uint32_t *pFrequency)
-:'''Description:'''
-::Reads the current backlight frequency of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 7'''.
-::'''pFrequency'''
-:::Pointer to a buffer that receives the current backlight frequency. (Unit: Hz)
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pFrequency==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.3.11SusiVga'''SetFrequency ===
- uint32_t SUSI_API SusiVgaSetFrequency(uint32_t Id, uint32_t Frequency)
-:'''Description:'''
-::Sets the frequency of the selected flat panel display.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 7'''.
-::'''Polarity'''
-:::Frequency value. (Unit: Hz)
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-== '''3.4 I2C Functions''' ==
-I<sup>2</sup>C APIs support standard 7 and 10 bits slave address mode. I<sup>2</sup>C APIs also support word command, it needs encode before set to parameter, see Table 13
-:'''Table '''12 I<sup>2</sup>C ID
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_I2C_EXTERNAL
-| style="width:302px;" |
-Main I<sup>2</sup>C host device
-|-
-| style="width:297px;" |
-SUSI_ID_I2C_OEM0~2
-| style="width:302px;" |
-Other I<sup>2</sup>C host devices
-|}
-:'''Table '''13 I<sup>2</sup>C command encode
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Type'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-Standard command
-| style="width:302px;" |
-Byte command
-|-
-| style="width:297px;" |
-Extend command
-| style="width:302px;" |
-Word command &#124; 0x80000000
-Ex. 0x8000FABC
-|-
-| style="width:297px;" |
-No command
-| style="width:302px;" |
-x4000xxxx, ignore command parameter
-|}
-=== '''3.4.1 SusiI2CGetCap'''s ===
- uint32_t SUSI_API SusiI2CGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue)
-:'''Description:'''
-::Gets I<sup>2</sup>C capabilities.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 12'''.
-::'''ItemId'''
-:::Selects target capability. See '''Table ''''''14'''.
-::'''pValue'''
-:::Pointer to a buffer that receives the target capability.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pValue==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id or ItemId
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table '''14 I<sup>2</sup>C capabilities item Id
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Item Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_I2C_MAXIMUM_BLOCK_LENGTH
-| style="width:302px;" |
-I<sup>2</sup>C maximum block length
-|-
-| style="width:297px;" |
-| style="width:302px;" |
-|}
-=== '''3.4.2 SusiI2CWriteReadCombine''' ===
- uint32_t SUSI_API SusiI2CWriteReadCombine(uint32_t Id, uint8_t Addr, uint8_t *pWBuffer, uint32_t WriteLen, uint8_t *pRBuffer, uint32_t ReadLen)
-:'''Description:'''
-::Universal function for read and write operations to the I<sup>2</sup>C bus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''14'''.
-::'''Addr'''
-:::First byte of I<sup>2</sup>C device address. 7-bit address only
-::'''pWBuffer'''
-:::Pointer to a buffer containing the data to be transferred. This parameter can be NULL if the data is not required.
-::'''WriteLen'''
-:::Size in bytes of the information pointed to by the pWBuffer parameter. If pWBuffer is NULL this will be ignored.
-::'''pRBuffer'''
-:::Pointer to a buffer that receives the read data. This parameter can be NULL if the data is not required.
-:'''ReadLen'''
-:::Size in bytes of the buffer pointed to by the pRBuffer parameter. If pRBuffer is NULL this will be ignored.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-(WriteLen>1)&&(pWBuffer==NULL)
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-(RBufLen>1)&&(pRBuffer==NULL)
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-(WriteLen==0)&&(RBufLen==0)
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.4.3 SusiI2CReadTransfer''' ===
- uint32_t SUSI_API SusiI2CReadTransfer(uint32_t Id, uint32_t Addr, uint32_t Cmd, uint8_t *pBuffer, uint32_t ReadLen)
-:'''Description:'''
-::Reads from a specific register in the selected I<sup>2</sup>C device. Reads from I<sup>2</sup>C device at the I<sup>2</sup>C address Addr the amount of ReadLen bytes to the buffer pBuffer while using the device specific command Cmd. Depending on the addressed I<sup>2</sup>C device Cmd can be a specific command or a byte offset.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''14'''.
-::'''Addr'''
-:::Encoded 7/10 Bit I<sup>2</sup>C Device Address.
-::'''Cmd'''
-:::Encoded I<sup>2</sup>C Device Command / Index. See '''Table ''''''13'''.
-::'''pBuffer'''
-:::Pointer to a buffer that receives the read data.
-::'''ReadLen'''
-:::Size in bytes of the buffer pointed to by the pBuffer parameter.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL &#124;&#124; ReadLen==0
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.4.4 SusiI2CWriteTransfer''' ===
- uint32_t SUSI_API SusiI2CWriteTransfer(uint32_t Id, uint32_t Addr, uint32_t Cmd, uint8_t *pBuffer, uint32_t ByteCnt)
-:'''Description:'''
-::Write to a specific register in the selected I<sup>2</sup>C device. Writes to an I<sup>2</sup>C device at the I<sup>2</sup>C address Addr the amount of ByteCnt bytes from the buffer *pBuffer while using the device specific command Cmd. Depending on the addressed I<sup>2</sup>C device Cmd can be a specific command or a byte offset
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''14'''.
-::'''Addr'''
-:::Encoded 7/10 Bit I<sup>2</sup>C Device Address.
-::'''Cmd'''
-:::Encoded I<sup>2</sup>C Device Command / Index. See '''Table ''''''13'''.
-::'''pBuffer'''
-:::Pointer to a buffer that receives the write data.
-::'''ByteCnt'''
-:::Size in bytes of the buffer pointed to by the pBuffer parameter.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL &#124;&#124; ByteCnt==0
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-ByteCnt > MaxLength
-| style="width:313px;" |
-SUSI_STATUS_INVALID_BLOCK_LENGTH
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.4.5 SusiI2CProbeDevice''' ===
- uint32_t SUSI_API SusiI2CProbeDevice(uint32_t Id, uint32_t Addr)
-:'''Description:'''
-::Probes I<sup>2</sup>C address to test I<sup>2</sup>C device present.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''14'''.
-::'''Addr'''
-:::Encoded 7/10 Bit I<sup>2</sup>C Device Address.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.4.6 SusiI2CGetFrequency''' ===
- uint32_t SUSI_API SusiI2CGetFrequency(uint32_t Id, uint32_t *pFreq)
-:'''Description:'''
-::Get I<sup>2</sup>C clock frequency.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''14'''.
-::'''pFreq'''
-:::Pointer to a buffer that receives the I<sup>2</sup>C clock frequency value. (Unit: Hz)
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-pFreq == NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.4.7 SusiI2C'''SetFrequency ===
- uint32_t SUSI_API SusiI2CSetFrequency(uint32_t Id, uint32_t Freq)
-:'''Description:'''
-::Set I<sup>2</sup>C clock frequency.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''14'''.
-::'''Freq'''
-:::I<sup>2</sup>C clock frequency value. (Unit: Hz)
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-== '''3.5 SMBus Functions''' ==
-SMBus is the System Management Bus defined by Intel Corporation in 1995. It is used in personal computers and servers for low-speed system management communications.
-:'''Table '''15 SMBus ID
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_ SMBUS _EXTERNAL
-| style="width:302px;" |
-Main SMBus host device
-|-
-| style="width:297px;" |
-SUSI_ID_SMBUS_OEM0~3
-| style="width:302px;" |
-Other SMBus host devices
-|}
-=== '''3.5.1 SusiSMBReadByte''' ===
- uint32_t SUSI_API SusiSMBReadByte(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint8_t *pData)
-:'''Description:'''
-::Read a byte of data from the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to read data from.
-::'''pData'''
-:::Pointer to a variable in which the function reads the byte data.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pData==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.2 SusiSMB'''WriteByte ===
- uint32_t SUSI_API SusiSMBWriteByte(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint8_t Data)
-:'''Description:'''
-::Write a byte of data to the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to write data to.
-::'''Data'''
-:::Specifies the byte data to be written.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.3 SusiSMBReadWord''' ===
- uint32_t SUSI_API SusiSMBReadWord(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint16_t *pData)
-:'''Description:'''
-::Read a word of data from the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to read data from.
-::'''pData'''
-:::Pointer to a variable in which the function reads the word data.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pData==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.4 SusiSMB'''WriteWord ===
- uint32_t SUSI_API SusiSMBWriteWord(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint16_t Data)
-:'''Description:'''
-::Write a word of data to the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to write data to.
-::'''Data'''
-:::Specifies the word data to be written.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.5 SusiSMB'''ReceiveByte ===
- uint32_t SUSI_API SusiSMBReceiveByte(uint32_t Id, uint8_t Addr, uint8_t *pData)
-:'''Description:'''
-::Receive a byte of data from the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''pData'''
-:::Pointer to a variable in which the function receive the byte data.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.6 SusiSMB'''SendByte ===
- uint32_t SUSI_API SusiSMBSendByte(uint32_t Id, uint8_t Addr, uint8_t Data)
-:'''Description:'''
-::Send a byte of data to the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15''''''.'''
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Data'''
-:::Specifies the word data to be sent.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.7 SusiSMBReadQuick''' ===
- uint32_t SUSI_API SusiSMBReadQuick(uint32_t Id, uint8_t Addr)
-:'''Description:'''
-::Turn SMBus device function off (on) or disable (enable) a specific device mode.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.8 SusiSMB'''WriteQuick ===
- uint32_t SUSI_API SusiSMBWriteQuick(uint32_t Id, uint8_t Addr)
-:'''Description:'''
-::Turn SMBus device function off (on) or disable (enable) a specific device mode.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.9 SusiSMBReadBlock''' ===
- uint32_t SUSI_API SusiSMBReadBlock(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint8_t *pBuffer, uint32_t *pLength)
-:'''Description:'''
-::Read multi-data from the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to read data from.
-::'''pBuffer'''
-:::Pointer to a byte array in which the function reads the block data.
-::'''pLength'''
-:::Pointer to a byte in which specifies the number of bytes to be read and also return succeed bytes.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.10 SusiSMB'''WriteBlock ===
- uint32_t SUSI_API SusiSMBWriteBlock(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint8_t *pBuffer, uint32_t Length)
-:'''Description:'''
-::Write multi-data from the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to write data to.
-::'''pBuffer'''
-:::Pointer to a byte array in which the function writes the block data.
-::'''Length'''
-:::Specifies the number of bytes to be write.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.11 SusiSMB'''I2CReadBlock ===
- uint32_t SUSI_API SusiSMBI2CReadBlock(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint8_t *pBuffer, uint32_t *pLength)
-:'''Description:'''
-::Read multi-data using I<sup>2</sup>C block protocol from the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to read data from.
-::'''pBuffer'''
-:::Pointer to a byte array in which the function reads the block data.
-::'''pLength'''
-:::Pointer to a byte in which specifies the number of bytes to be read and also return succeed bytes.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.5.12 SusiSMB'''I2CWriteBlock ===
- uint32_t SUSI_API SusiSMBI2CWriteBlock(uint32_t Id, uint8_t Addr, uint8_t Cmd, uint8_t *pBuffer, uint32_t Length)
-:'''Description:'''
-::Write multi-data using I<sup>2</sup>C block protocol from the target slave device in the SMBus.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table ''''''15'''.
-::'''Addr'''
-:::Specifies the 8-bit device address, ranging from 0x00 to 0xFF. Whether to give a 1 (read) or 0 (write) to the LSB of slave address could be ignored.
-::'''Cmd'''
-:::Specifies the offset or command of the device register to write data to.
-::'''pBuffer'''
-:::Pointer to a byte array in which the function writes the block data.
-::'''Length'''
-:::Specifies the number of bytes to be write.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device unsupported
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Bus Busy SDA/SDC low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Arbitration Error/Collision Error
-On Write 1 write cycle
-SDA Remains low
-| style="width:313px;" |
-SUSI_STATUS_BUSY_COLLISION
-|-
-| style="width:293px;" |
-Time-out due to clock stretching
-| style="width:313px;" |
-SUSI_STATUS_TIMEOUT
-|-
-| style="width:293px;" |
-Address Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_NOT_FOUND
-|-
-| style="width:293px;" |
-Write Non-ACK
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.6 Watchdog Functions''' ===
-After the watchdog timer has been start function it must be triggered within (Delay + Event Timeout) milliseconds as set with the start function, following the initial trigger every subsequent trigger must occur within (Event Timeout) milliseconds. Should trigger not be called within the relevant time limit a system reset will occur. The SUSI watchdog timer may support two stages. If the watchdog is not triggered within the event timeout, an NMI, IRQ, or hardware output will be generated. Then the reset timeout becomes active. If the watchdog timer is not triggered within the reset timeout a reset will be generated
-:'''Initial timing:'''
-::[[File:Initial timing.png|RTENOTITLE]]
-:'''Timing after trigger:'''
-::[[File:Timing after trigger.png|RTENOTITLE]]
-:'''Where:'''
-::'''Stage A'''
-:::Watchdog is started.
-::'''Stage B'''
-:::Initial Delay Period is exhausted.
-::'''Stage C/F'''
-:::Event is triggered, NMI, IRQ, or PIN is Triggered. To Allow for possible Software Recovery.
-::'''Stage D/G'''
-:::System is reset.
-::'''Stage E'''
-<ul style="margin-left: 160px;">
-<li>Watchdog is Triggered.</li>
-<li>Trigger / Stop must be called before Stage C/F to prevent event from being generated.</li>
-<li>Trigger / Stop must be called before Stage D/G to prevent The system from being reset.</li>
-</ul>
-:'''Table 16 Watchdog ID'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_WATCHDOG_1
-| style="width:302px;" |
-First watchdog timer
-|-
-| style="width:297px;" |
-SUSI_ID_WATCHDOG_2
-| style="width:302px;" |
-Second watchdog timer
-|-
-| style="width:297px;" |
-SUSI_ID_WATCHDOG_3
-| style="width:302px;" |
-Third watchdog timer
-|}
-=== '''3.6.1 SusiWDogGetCaps''' ===
- uint32_t SUSI_API SusiWDogGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue)
-:'''Description:'''
-::Gets watchdog capabilities.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 16'''.
-::'''ItemId'''
-:::Selects target capability. See '''Table 17'''.
-::'''pValue'''
-:::Pointer to a buffer that receives the target capability.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pValue==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id or ItemId
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table '''17 Watchdog capabilities item Id
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Item Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_SUPPORT_FLAGS
-| style="width:302px;" |
-Event support flags ('''Table 18''')
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_DELAY_MAXIMUM
-| style="width:302px;" |
-The maximum delay time value
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_DELAY_MINIMUM
-| style="width:302px;" |
-The minimum delay time value
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_EVENT_MAXIMUM
-| style="width:302px;" |
-The maximum event time value
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_EVENT_MINIMUM
-| style="width:302px;" |
-The minimum event time value
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_RESET_MAXIMUM
-| style="width:302px;" |
-The maximum reset time value
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_RESET_MINIMUM
-| style="width:302px;" |
-The minimum reset time value
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_UNIT_MINIMUM
-| style="width:302px;" |
-The minimum unit value
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_DELAY_TIME
-| style="width:302px;" |
-Current delay time setting
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_EVENT_TIME
-| style="width:302px;" |
-Current event time setting
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_RESET_TIME
-| style="width:302px;" |
-Current reset time setting
-|-
-| style="width:297px;" |
-SUSI_ID_WDT_EVENT_TYPE
-| style="width:302px;" |
-Current event type ('''Table 19''')
-|}
-=== '''3.6.2 SusiWDogStart''' ===
- uint32_t SUSI_API SusiWDogStart(uint32_t Id, uint32_t DelayTime, uint32_t EventTime, uint32_t ResetTime, uint32_t EventType)
-:'''Description:'''
-::Start the watchdog timer and set the parameters. To adjust the parameters, the watchdog must be stopped and then start again with the new values. If the hardware implementation of the watchdog timer does not allow a setting at the exact time selected, the SUSI API selects the next possible longer timing.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 16'''.
-::'''DelayTime'''
-:::Initial delay for the watchdog timer in milliseconds.
-::'''EventTime'''
-:::Watchdog timeout interval in milliseconds to trigger an event.
-::'''ResetTime'''
-:::Watchdog timeout interval in milliseconds to trigger a reset.
-::'''EventType'''
-:::To select one kind of event type. See '''Table 19'''.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Wrong time range
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table '''18 Watchdog Support Flags
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Flag Name'''
-| style="width:246px;" |
-'''Description'''
-| style="width:59px;" |
-'''Value'''
-|-
-| style="width:297px;" |
-SUSI_WDT_FLAG_SUPPORT_IRQ
-| style="width:246px;" |
-Support IRQ event
-| style="width:59px;" |
-x01
-|-
-| style="width:297px;" |
-SUSI_WDT_FLAG_SUPPORT_SCI
-| style="width:246px;" |
-Support SCI event
-| style="width:59px;" |
-x02
-|-
-| style="width:297px;" |
-SUSI_WDT_FLAG_SUPPORT_PWRBTN
-| style="width:246px;" |
-Support power button event
-| style="width:59px;" |
-x04
-|}
-:'''Table '''19 Watchdog timer event type
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Event Type'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_WDT_EVENT_TYPE_NONE
-| style="width:302px;" |
-No event
-|-
-| style="width:297px;" |
-SUSI_WDT_EVENT_TYPE_SCI
-| style="width:302px;" |
-SCI event
-|-
-| style="width:297px;" |
-SUSI_WDT_EVENT_TYPE_IRQ
-| style="width:302px;" |
-IRQ event
-|-
-| style="width:297px;" |
-SUSI_WDT_EVENT_TYPE_PWRBTN
-| style="width:302px;" |
-Power button event
-|}
-=== '''3.6.3 SusiWDogStop''' ===
- uint32_t SUSI_API SusiWDogStop(uint32_t Id)
-:'''Description:'''
-::Stops the operation of the watchdog timer.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 16'''.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.6.4 SusiWDog'''Trigger ===
- uint32_t SUSI_API SusiWDogTrigger(uint32_t Id)
-:'''Description:'''
-::Trigger the watchdog timer.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 16'''.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.6.5 SusiWDogSetCallBack''' ===
- uint32_t SUSI_API SusiWDogSetCallBack(uint32_t Id, SUSI_WDT_INT_CALLBACK pfnCallback, void *Context)
-:'''Description:'''
-::The call back function pointer can be transmit from Application when IRQ triggered.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 16'''.
-::'''pfnCallback'''
-:::Call back function pointer, SUSI_WDT_INT_CALLBACK is function pointer type, it can set NULL to clear. The type definition just like show below,
-:::''typedef void (*SUSI_WDT_INT_CALLBACK)(void*);''
-::'''Context'''
-:::Pointer to a user context structure for callback function.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-== '''3.7 GPIO Functions''' ==
-Programmable GPIO allows developers to dynamically set the GPIO input or output status
-:'''Table '''20 GPIO ID
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:259px;" |
-'''Id'''
-| style="width:340px;" |
-'''Description'''
-|-
-| style="width:259px;" |
-SUSI_ID_GPIO(X)
-| style="width:340px;" |
-X is GPIO pin number, definition as below:
-#define SUSI_ID_GPIO(x) (0x0000 &#124; x)
-This ID control single pin only.
-|-
-| style="width:259px;" |
-SUSI_ID_GPIO_BANK(Y)
-| style="width:340px;" |
-Y is GPIO bank number, definition as below:
-#define SUSI_ID_GPIO_BANK(Y) (0x10000 &#124; Y)
-This ID control maximum 32 pins per bank.
-|}
-=== '''3.7.1 SusiGPIOGetCaps''' ===
- uint32_t SUSI_API SusiGPIOGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue)
-:'''Description:'''
-::Reads the capabilities of the current GPIO implementation from the selected GPIO interface.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 20'''.
-::'''ItemId'''
-:::Selects target capability. See '''Table 21'''.
-::'''pValue'''
-:::Pointer to a buffer that receives the target capability. Each bit of the buffer value represents support situation of a GPIO, according to the order. 1 is supportive, and 0 is unsupportive.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pValue==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table '''21 GPIO capabilities item Id
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Item Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_GPIO_INPUT_SUPPORT
-| style="width:302px;" |
-Get GPIO input support state
-|-
-| style="width:297px;" |
-SUSI_ID_GPIO_OUTPUT_SUPPORT
-| style="width:302px;" |
-Get GPIO output support state
-|}
-=== '''3.7.2 SusiGPIOGetDirection''' ===
- uint32_t SUSI_API SusiGPIOGetDirection(uint32_t Id, uint32_t Bitmask, uint32_t *pDirection)
-:'''Description:'''
-::Gets the configuration for the selected GPIO ports.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 20'''.
-::'''Bitmask'''
-:::Value for a bit mask. Only selected bits are changed, unselected bits remain unchanged. This parameter will be ignored when single pin mode.
-::'''pDirection'''
-:::Pointer to a buffer that receives the direction of the selected GPIO ports.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pDirection==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Bitmask==0 when bank mode
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.7.3 SusiGPIOSetDirection''' ===
- uint32_t SUSI_API SusiGPIOSetDirection(uint32_t Id, uint32_t Bitmask, uint32_t Direction)
-:'''Description:'''
-:::Sets the configuration for the selected GPIO ports.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 20'''.
-::'''Bitmask'''
-:::Value for a bit mask. Only selected bits are changed, unselected bits remain unchanged. This parameter will be ignored when single pin mode.
-::'''Direction'''
-:::Sets the direction of the selected GPIO ports.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Bitmask==0 when bank mode
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.7.4 SusiGPIOGetLevel''' ===
- uint32_t SUSI_API SusiGPIOGetLevel(uint32_t Id, uint32_t Bitmask, uint32_t *pLevel)
-:'''Description:'''
-::Read level the from GPIO ports.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 20'''.
-::'''Bitmask'''
-:::Value for a bit mask. Only selected bits are changed, unselected bits remain unchanged. This parameter will be ignored when single pin mode.
-::'''pLevel'''
-:::Pointer to a buffer that receives the GPIO level.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pLevel==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Bitmask==0 when bank mode
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.7.5 SusiGPIOSetLevel''' ===
- uint32_t SUSI_API SusiGPIOSetLevel(uint32_t Id, uint32_t Bitmask, uint32_t Level)
-:'''Description:'''
-::Write level to GPIO ports. Depending on the hardware implementation writing multiple GPIO ports with the bit mask option does not guarantee a time synchronous change of the output levels.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 20'''.
-::'''Bitmask'''
-:::Value for a bit mask. Only selected bits are changed, unselected bits remain unchanged. This parameter will be ignored when single pin mode.
-::'''Level'''
-:::Input level of the selected GPIO port.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-Bitmask==0 when bank mode
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-== '''3.8 Smart Fan Functions''' ==
-The Smart Fan function call is used to set fan speed configuration. You can use this function to easily control the fan speed. It takes a pointer to an instance of structure ''SusiFanControl'', which is defined as follows:
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:598px;height:582px;" | <pre>#define SUSI_FAN_AUTO_CTRL_OPMODE_PWM 0
-#define SUSI_FAN_AUTO_CTRL_OPMODE_RPM 1
-typedef struct _AutoFan {
- uint32_t TmlSource; // Thermal source
- uint32_t OpMode;
- uint32_t LowStopLimit; // Temperature (0.1 Kelvins)
- uint32_t LowLimit; // Temperature (0.1 Kelvins)
- uint32_t HighLimit; // Temperature (0.1 Kelvins)
- uint32_t MinPWM; // Enable when OpMode == FAN_AUTO_CTRL_OPMODE_PWM
- uint32_t MaxPWM; // Enable when OpMode == FAN_AUTO_CTRL_OPMODE_PWM
- uint32_t MinRPM; // Enable when OpMode == FAN_AUTO_CTRL_OPMODE_RPM
- uint32_t MaxRPM; // Enable when OpMode == FAN_AUTO_CTRL_OPMODE_RPM
-} AutoFan , *PAutoFan&nbsp;;
-// Mode
-#define SUSI_FAN_CTRL_MODE_OFF 0
-#define SUSI_FAN_CTRL_MODE_FULL 1
-#define SUSI_FAN_CTRL_MODE_MANUAL 2
-#define SUSI_FAN_CTRL_MODE_AUTO 3
-typedef struct _SusiFanControl {
- uint32_t Mode;
- uint32_t PWM; // Manual mode only (0 - 100%)
- AutoFan AutoControl; // Auto mode only
-} SusiFanControl, *PSusiFanControl;
-</pre>
-|}
-If Mode member of SusiFanControl is not Auto, AutoControl member will be ignored. In auto mode, parameter “TmlSource” is use ''SUSI_ID_HWM_TEMP_XXX'' ('''Table 3''') to select which thermal type to reference. If TmlSource is not match any temperature ID means unknown or unsupported.
-=== '''3.8.1 SusiFanControlGetCaps''' ===
- uint32_t SUSI_API SusiFanControlGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue)
-:'''Description:'''
-::Gets fan control capabilities.
-:'''Parameters:'''
-::'''Id'''
-:::Smart fan ID is same as Fan Speed Value ID. See '''Table 4'''.
-::'''ItemId'''
-:::Selects target capability. See '''Table 22'''. This parameter can also input temperature ID ('''Table 3''') to get is it supports in ''SusiFanControl'' function.
-::'''pValue'''
-:::Pointer to a buffer that receives the target capability.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pValue==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id or ItemId
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table '''22 Fan control capabilities item Id
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Item Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_FC_CONTROL_SUPPORT_FLAGS
-| style="width:302px;" |
-Control support flags (See '''Table 23''')
-|-
-| style="width:297px;" |
-SUSI_ID_FC_AUTO_SUPPORT_FLAGS
-| style="width:302px;" |
-Auto support flags (See '''Table 24''')
-|}
-:'''Table '''23 Control Support Flags
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:267px;" |
-'''Flag Name'''
-| style="width:276px;" |
-'''Description'''
-| style="width:59px;" |
-'''Value'''
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_OFF_MODE
-| style="width:276px;" |
-Support off mode
-| style="width:59px;" |
-x01
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_FULL_MODE
-| style="width:276px;" |
-Support full mode
-| style="width:59px;" |
-x02
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_MANUAL_MODE
-| style="width:276px;" |
-Support manual mode
-| style="width:59px;" |
-x04
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_AUTO_MODE
-| style="width:276px;" |
-Support auto mode
-More detail to get ''Auto Support Flags''
-| style="width:59px;" |
-x08
-|}
-:'''Table '''24 Auto Support Flags
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:267px;" |
-'''Flag Name'''
-| style="width:276px;" |
-'''Description'''
-| style="width:59px;" |
-'''Value'''
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_AUTO_LOW_STOP
-| style="width:276px;" |
-Auto mode support Low Stop
-| style="width:59px;" |
-x01
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_AUTO_LOW_LIMIT
-| style="width:276px;" |
-Auto mode support Low Limit
-| style="width:59px;" |
-x02
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_AUTO_HIGH_LIMIT
-| style="width:276px;" |
-Auto mode support High Limit
-| style="width:59px;" |
-x04
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_AUTO_PWM
-| style="width:276px;" |
-Auto mode support PWM operation
-| style="width:59px;" |
-x0100
-|-
-| style="width:267px;" |
-SUSI_FC_FLAG_SUPPORT_AUTO_RPM
-| style="width:276px;" |
-Auto mode support RPM operation
-| style="width:59px;" |
-x0200
-|}
-=== '''3.8.2 SusiFanControlGetConfig''' ===
- uint32_t SUSI_API SusiFanControlGetConfig(uint32_t Id, SusiFanControl *pConfig)
-:'''Description:'''
-::Get information about smart fan function mode and configuration.
-:'''Parameters:'''
-::'''Id'''
-:::Smart fan ID is same as Fan Speed Value ID. See '''Table 4'''.
-::'''pConfig'''
-:::Pointer to the smart fan function configuration.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pConfig==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device not support smart mode
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.8.3 SusiFanControlSetConfig''' ===
- uint32_t SUSI_API SusiFanControlSetConfig(uint32_t Id, SusiFanControl *pConfig)
-:'''Description:'''
-:::Set smart fan function mode and configuration.
-:'''Parameters:'''
-::'''Id'''
-:::Smart fan ID is same as Fan Speed Value ID. See '''Table 4'''.
-::'''pConfig'''
-:::Pointer to the smart fan function configuration.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pConfig==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Wrong configuration
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-== '''3.9 Storage Functions''' ==
-Access storage information and read / write data to the selected user data area. Developers can use this area to store their own data.
-:'''Table '''25 Storage ID
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:316px;" |
-'''Id'''
-| style="width:283px;" |
-'''Description'''
-|-
-| style="width:316px;" |
-SUSI_ID_STORAGE_STD
-| style="width:283px;" |
-Standard storage device
-|-
-| style="width:316px;" |
-SUSI_ID_STORAGE_OEM0~1
-| style="width:283px;" |
-Other storage devices
-|}
-=== '''3.9.1 SusiStorageGetCaps''' ===
- uint32_t SUSI_API SusiStorageGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue)
-:'''Description:'''
-::Reads the capabilities of the current storage implementation from the selected storage interface.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 25'''.
-::'''ItemId'''
-:::Selects target capability. See '''Table 26'''.
-::'''pValue'''
-:::Pointer to a buffer that receives the target capability.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pValue==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device not support
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table '''26 Storage capabilities item Id
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Item Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_STORAGE_TOTAL_SIZE
-| style="width:302px;" |
-Get storage total size in bytes
-|-
-| style="width:297px;" |
-SUSI_ID_STORAGE_BLOCK_SIZE
-| style="width:302px;" |
-Get storage block size in bytes
-|-
-| style="width:297px;" |
-SUSI_ID_STORAGE_LOCK_STATUS
-| style="width:302px;" |
-Get storage lock status. See '''Table 27'''.
-|-
-| style="width:297px;" |
-SUSI_ID_STORAGE_PSW_MAX_LEN
-| style="width:302px;" |
-Get maximum length in byte of storage lock key
-|}
-:'''Table '''27 Storage Lock Status
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Lock Status'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_STORAGE_STATUS_LOCK
-| style="width:302px;" |
-Storage is lock
-|-
-| style="width:297px;" |
-SUSI_STORAGE_STATUS_UNLOCK
-| style="width:302px;" |
-Storage is unlock
-|}
-=== '''3.9.2 SusiStorageAreaRead''' ===
- uint32_t SUSI_API SusiStorageAreaRead(uint32_t Id, uint32_t Offset, uint8_t *pBuffer, uint32_t BufLen)
-:'''Description:'''
-::Reads data from the selected user data area.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 25'''.
-::'''Offset'''
-:::Storage area start address offset in bytes.
-::'''pBuffer'''
-:::Size in bytes of the buffer pointed to by the pBuffer parameter.
-::'''BufLen'''
-:::Size in bytes of the information read to the buffer pointed to by the pBuffer parameter.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL &#124;&#124; BufLen==0
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Offset+BufLen>TotalSize
-| style="width:313px;" |
-SUSI_STATUS_INVALID_BLOCK_LENGTH
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Read error
-| style="width:313px;" |
-SUSI_STATUS_READ_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.9.3 SusiStorageArea'''Write ===
- uint32_t SUSI_API SusiStorageAreaWrite(uint32_t Id, uint32_t Offset, uint8_t *pBuffer, uint32_t BufLen)
-:'''Description:'''
-::Writes data to the selected user data area.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 25'''.
-::'''Offset'''
-:::Storage area start address offset in bytes.
-::'''pBuffer'''
-:::Size in bytes of the buffer pointed to by the pBuffer parameter.
-::'''BufLen'''
-:::Size in bytes of the information read to the buffer pointed to by the pBuffer parameter.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL &#124;&#124; BufLen==0
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Offset+BufLen>TotalSize
-| style="width:313px;" |
-SUSI_STATUS_INVALID_BLOCK_LENGTH
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Write error
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.9.4 SusiStorageArea'''SetLock ===
- uint32_t SUSI_API SusiStorageAreaSetLock(uint32_t Id, uint8_t *pBuffer, uint32_t BufLen)
-:'''Description:'''
-::Lock a storage area for write protect.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 25'''.
-::'''pBuffer'''
-:::Lock of key buffer.
-::'''BufLen'''
-:::Number of key buffer
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL &#124;&#124; BufLen==0
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Lock error
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device not support
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.9.5 SusiStorageArea'''SetUnlock ===
- uint32_t SUSI_API SusiStorageAreaSetUnlock(uint32_t Id, uint8_t *pBuffer, uint32_t BufLen)
-:'''Description:'''
-::Unlock a storage area for write protect.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 25'''.
-::'''pBuffer'''
-:::Unlock of key buffer.
-::'''BufLen'''
-:::Number of key buffer
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pBuffer==NULL &#124;&#124; BufLen==0
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unlock error
-| style="width:313px;" |
-SUSI_STATUS_WRITE_ERROR
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Device not support
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-== '''3.10Thermal Protection Functions''' ==
-The Thermal Protection function call is used to set hardware base thermal monitoring and notify. It takes a pointer to an instance of structure ''SusiThermalProtect'', which is defined as follows:
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:592px;" | <pre>typedef struct _SusiThermalProtect{
- uint32_t SourceId;
- uint32_t EventType;
- uint32_t SendEventTemperature;
- uint32_t ClearEventTemperature;
-} SusiThermalProtect, *PSusiThermalProtect;
-</pre>
-|}
-:'''Where:'''
-::'''SourceId'''
-:::Setting thermal source ID here. See '''Table 3'''.
-::'''EventType'''
-:::This byte can set up a thermal protect event, see '''Table 28'''. NOT every platform supports all event type.
-::'''SendEevntTemperature'''
-:::Unit is 0.1 Kelvins. When thermal source goes over this value, SUSI will send event according Event Type.
-::'''ClearEventTemperature'''
-:::Unit is 0.1 Kelvins. When thermal source goes below this value and Event is sent, SUSI will clear event according Event Type
-:'''Table '''28 Thermal Protection Event Type
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:267px;" |
-'''Event Type Name'''
-| style="width:276px;" |
-'''Description'''
-| style="width:59px;" |
-'''Value'''
-|-
-| style="width:267px;" |
-SUSI_THERMAL_EVENT_SHUTDOWN
-| style="width:276px;" |
-Shutdown event
-| style="width:59px;" |
-x00
-|-
-| style="width:267px;" |
-SUSI_THERMAL_EVENT_THROTTLE
-| style="width:276px;" |
-Throttle event
-| style="width:59px;" |
-x01
-|-
-| style="width:267px;" |
-SUSI_THERMAL_EVENT_POWEROFF
-| style="width:276px;" |
-Power off event
-| style="width:59px;" |
-x02
-|-
-| style="width:267px;" |
-SUSI_THERMAL_EVENT_NONE
-| style="width:276px;" |
-No event
-| style="width:59px;" |
-xFF
-|}
-:'''Table '''29 Thermal Protection ID
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:268px;" |
-'''Id'''
-| style="width:331px;" |
-'''Description'''
-|-
-| style="width:268px;" |
-SUSI_ID_THERMAL_PROTECT_1
-| style="width:331px;" |
-Thermal protection zone 1
-|-
-| style="width:268px;" |
-SUSI_ID_THERMAL_PROTECT_2
-| style="width:331px;" |
-Thermal protection zone 2
-|-
-| style="width:268px;" |
-SUSI_ID_THERMAL_PROTECT_3
-| style="width:331px;" |
-Thermal protection zone 3
-|-
-| style="width:268px;" |
-SUSI_ID_THERMAL_PROTECT_4
-| style="width:331px;" |
-Thermal protection zone 4
-|}
-=== '''3.10.1 SusiThermalProtectionGetCaps''' ===
- uint32_t SUSI_API SusiThermalProtectionGetCaps(uint32_t Id, uint32_t ItemId, uint32_t *pValue)
-:'''Description:'''
-::Gets Thermal Protection capabilities.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 29'''.
-::'''ItemId'''
-:::Selects target capability. See '''Table 30'''. This parameter can also input temperature ID ('''Table 3''') to get is it supports in ''SusiThermalProtection'' function.
-::'''pValue'''
-:::Pointer to a buffer that receives the target capability.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pValue==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id or ItemId
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-:'''Table '''30 Thermal Protection capabilities item Id
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:297px;" |
-'''Item Id'''
-| style="width:302px;" |
-'''Description'''
-|-
-| style="width:297px;" |
-SUSI_ID_TP_EVENT_SUPPORT_FLAGS
-| style="width:302px;" |
-Event support flags (See '''Table 31''')
-|-
-| style="width:297px;" |
-SUSI_ID_TP_EVENT_TRIGGER_MAXIMUM
-| style="width:302px;" |
-The maximum temperature to trigger event
-|-
-| style="width:297px;" |
-SUSI_ID_TP_EVENT_TRIGGER_MINIMUM
-| style="width:302px;" |
-The minimum temperature to trigger event
-|-
-| style="width:297px;" |
-SUSI_ID_TP_EVENT_CLEAR_MAXIMUM
-| style="width:302px;" |
-The maximum temperature to clear event
-|-
-| style="width:297px;" |
-SUSI_ID_TP_EVENT_CLEAR_MINIMUM
-| style="width:302px;" |
-The minimum temperature to clear event
-|}
-:'''Table '''31 Thermal Protection Support Flags
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:267px;" |
-'''Flag Name'''
-| style="width:276px;" |
-'''Description'''
-| style="width:59px;" |
-'''Value'''
-|-
-| style="width:267px;" |
-SUSI_THERMAL_FLAG_SUPPORT_SHUTDOWN
-| style="width:276px;" |
-Support shutdown event
-| style="width:59px;" |
-x01
-|-
-| style="width:267px;" |
-SUSI_THERMAL_FLAG_SUPPORT_THROTTLE
-| style="width:276px;" |
-Support throttle event
-| style="width:59px;" |
-x02
-|-
-| style="width:267px;" |
-SUSI_THERMAL_FLAG_SUPPORT_POWEROFF
-| style="width:276px;" |
-Support power off event
-| style="width:59px;" |
-x04
-|}
-=== '''3.10.2 SusiThermalProtectionSetConfig''' ===
- uint32_t SUSI_API SusiThermalProtectionSetConfig(uint32_t Id, SusiThermalProtect *pConfig)
-:'''Description:'''
-::Set Thermal Protection configuration.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 29'''.
-::'''pConfig'''
-:::A data package for thermal protection.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pConfig==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Config invalid
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Source Id or event type not support
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-=== '''3.10.3 SusiThermalProtection'''GetConfig ===
- uint32_t SUSI_API SusiThermalProtectionGetConfig(uint32_t Id, SusiThermalProtect *pConfig)
-:'''Description:'''
-::Get Thermal Protection configuration.
-:'''Parameters:'''
-::'''Id'''
-:::Selects target device. See '''Table 29'''.
-::'''pConfig'''
-:::A data package for thermal protection.
-:'''Return Status Code:'''
-{| border="1" cellspacing="0" cellpadding="0" style="margin:1em auto 1em auto;"
-|-
-| style="width:293px;" |
-'''Condition'''
-| style="width:313px;" |
-'''Return Value'''
-|-
-| style="width:293px;" |
-Library uninitialized
-| style="width:313px;" |
-SUSI_STATUS_NOT_INITIALIZED
-|-
-| style="width:293px;" |
-pConfig==NULL
-| style="width:313px;" |
-SUSI _STATUS_INVALID_PARAMETER
-|-
-| style="width:293px;" |
-Unknown Id
-| style="width:313px;" |
-SUSI _STATUS_UNSUPPORTED
-|-
-| style="width:293px;" |
-Success
-| style="width:313px;" |
-SUSI_STATUS_SUCCESS
-|}
-<headertabs></headertabs>