mtb-pmbus 1.2.0.1772
 
Loading...
Searching...
No Matches
Enumerated Types

General Description

Enumerations

enum  mtb_pmbus_ctrl_status_t {
  MTB_PMBUS_CTRL_STATUS_SUCCESS = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 0U) ,
  MTB_PMBUS_CTRL_STATUS_BAD_PARAM = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 1U) ,
  MTB_PMBUS_CTRL_STATUS_IS_BUSY = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 2U) ,
  MTB_PMBUS_CTRL_STATUS_IS_READY = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 3U) ,
  MTB_PMBUS_CTRL_STATUS_UNKNOWN_ERR = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 4U) ,
  MTB_PMBUS_CTRL_STATUS_BUS_IS_BUSY = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 5U) ,
  MTB_PMBUS_CTRL_STATUS_TIMEOUT = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 6U) ,
  MTB_PMBUS_CTRL_STATUS_TRANSFER_ERR = CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_PMBUS, 7U)
}
 Controller statuses. More...
 
enum  mtb_pmbus_ctrl_events_t {
  MTB_PMBUS_CTRL_TRANSFER_DONE = 0U ,
  MTB_PMBUS_CTRL_CORRUPTED_DATA = 1U ,
  MTB_PMBUS_CTRL_TARGET_NACK_ADDR = 2U ,
  MTB_PMBUS_CTRL_BUS_ERR = 3U ,
  MTB_PMBUS_CTRL_TIMEOUT = 4U ,
  MTB_PMBUS_CTRL_TARGET_NACK_BYTE = 5U ,
  MTB_PMBUS_CTRL_TARGET_NACK_CMD = 6U ,
  MTB_PMBUS_CTRL_ARB_LOST = 7U ,
  MTB_PMBUS_CTRL_ABORT_START = 8U ,
  MTB_PMBUS_CTRL_BLOCK_COUNT_TOO_BIG = 9U
}
 Controller events. More...
 
enum  mtb_pmbus_ctrl_host_notify_events_t {
  MTB_PMBUS_CTRL_HOST_NOTIFY_COMPLETE = 0U ,
  MTB_PMBUS_CTRL_HOST_NOTIFY_REQUEST_RECEIVED = 1U ,
  MTB_PMBUS_CTRL_HOST_NOTIFY_ERROR = 2U
}
 Host Notify events. More...
 
enum  mtb_pmbus_ctrl_hw_resources_ctrl_action_t {
  MTB_PMBUS_CTRL_HW_RESOURCES_INIT = 0U ,
  MTB_PMBUS_CTRL_HW_RESOURCES_ENABLE = 1U ,
  MTB_PMBUS_CTRL_HW_RESOURCES_DISABLE = 2U
}
 Events for HW initialization. More...
 

Enumeration Type Documentation

◆ mtb_pmbus_ctrl_status_t

Controller statuses.

Enumerator
MTB_PMBUS_CTRL_STATUS_SUCCESS 

Correct status, No error.

MTB_PMBUS_CTRL_STATUS_BAD_PARAM 

The provided command code is incorrect.

MTB_PMBUS_CTRL_STATUS_IS_BUSY 

The controller is busy.

MTB_PMBUS_CTRL_STATUS_IS_READY 

The controller is ready to send data.

MTB_PMBUS_CTRL_STATUS_UNKNOWN_ERR 

The unknown error.

MTB_PMBUS_CTRL_STATUS_BUS_IS_BUSY 

The I2C Bus is busy.

MTB_PMBUS_CTRL_STATUS_TIMEOUT 

Timeout.

MTB_PMBUS_CTRL_STATUS_TRANSFER_ERR 

The last transfer finished with an error.

The controller is ready to send data

◆ mtb_pmbus_ctrl_events_t

Controller events.

Enumerator
MTB_PMBUS_CTRL_TRANSFER_DONE 

The Transfer is completed.

MTB_PMBUS_CTRL_CORRUPTED_DATA 

The incorrect PEC is received.

MTB_PMBUS_CTRL_TARGET_NACK_ADDR 

The Target sends NACK to Address.

MTB_PMBUS_CTRL_BUS_ERR 

A bus error occurred on the I2C bus.

MTB_PMBUS_CTRL_TIMEOUT 

A timeout is detected.

MTB_PMBUS_CTRL_TARGET_NACK_BYTE 

Target sends NACK to the data byte.

MTB_PMBUS_CTRL_TARGET_NACK_CMD 

Target sends NACK to the command code.

MTB_PMBUS_CTRL_ARB_LOST 

Controller arbitration lost.

MTB_PMBUS_CTRL_ABORT_START 

Controller abort starts.

MTB_PMBUS_CTRL_BLOCK_COUNT_TOO_BIG 

The received block count is too big.

◆ mtb_pmbus_ctrl_host_notify_events_t

Host Notify events.

Note
This enum is only available when MTB_PMBUS_CTRL_SUPPORT_HOST_NOTIFY is enabled at compile time options.
Enumerator
MTB_PMBUS_CTRL_HOST_NOTIFY_COMPLETE 

The Host Notify transfer successful complete.

MTB_PMBUS_CTRL_HOST_NOTIFY_REQUEST_RECEIVED 

The Host Notify request received.

MTB_PMBUS_CTRL_HOST_NOTIFY_ERROR 

An error occurred during Host Notify transfer.

◆ mtb_pmbus_ctrl_hw_resources_ctrl_action_t

Events for HW initialization.

Enumerator
MTB_PMBUS_CTRL_HW_RESOURCES_INIT 

Initialize the HW resources.

MTB_PMBUS_CTRL_HW_RESOURCES_ENABLE 

Enable the I2C HW.

MTB_PMBUS_CTRL_HW_RESOURCES_DISABLE 

Disable the I2C HW.