hal::serial::IICMaster 結構 參考文件

[Interface] IIC主端設備介面 更多...

#include <IICMaster.h>

類別hal::serial::IICMaster的繼承圖:

複合項目
struct	EventError
	[Interface] IIC錯誤事件處理器 更多...

公開方法(Public Methods)
virtual hal::serial::IIC &	getIIC (void) override
	取得IIC基礎介面參考
virtual bool	isBusy (void) override
	檢查總線狀態
virtual void	setClock (uint32 hz) override
	設定傳輸時脈頻率
virtual uint32	getClock (void) override
	讀取當前傳輸時脈頻率
virtual bool	beginWrite (uint16 address) override
	開始傳輸事件
virtual bool	beginRead (uint16 address) override
	開始讀取事件
virtual bool	abort (void) override
	中止當前傳輸
virtual void	setEventError (hal::serial::IICMaster::EventError *event=nullptr) override
	設定錯誤事件處理器

詳細描述

[Interface] IIC主端設備介面

實現IIC主設備的基本功能，包含時脈設定、資料傳輸控制 及錯誤處理等機制。

自

1.0.0

函式成員說明文件

abort()

virtual bool hal::serial::IICMaster::abort ( void )

pure virtual

中止當前傳輸

傳回值

true 成功中止

false 無傳輸可中止或中止失敗

實作於 mcxa153::core::CoreIICMaster.

beginRead()

virtual bool hal::serial::IICMaster::beginRead ( uint16 address )

pure virtual

開始讀取事件

參數

address

讀取目標地址

傳回值

返回狀態

• [true] 成功開始讀取
• [false] 開始失敗，可能原因如下
• - 設備忙碌中，正在傳輸。
• - 總線忙碌。
• - 設備尚未初始化。

實作於 mcxa153::core::CoreIICMaster.

beginWrite()

virtual bool hal::serial::IICMaster::beginWrite ( uint16 address )

pure virtual

開始傳輸事件

參數

address

傳輸目標地址

傳回值

返回狀態

• [true] 成功開始傳輸
• [false] 開始失敗，可能原因如下
• - 設備忙碌中，正在傳輸。
• - 總線忙碌。
• - 設備尚未初始化。

實作於 mcxa153::core::CoreIICMaster.

getClock()

virtual uint32 hal::serial::IICMaster::getClock ( void )

pure virtual

讀取當前傳輸時脈頻率

傳回值

uint32 當前頻率

實作於 mcxa153::core::CoreIICMaster.

getIIC()

virtual hal::serial::IIC & hal::serial::IICMaster::getIIC ( void )

pure virtual

取得IIC基礎介面參考

傳回值

hal::serial::IIC& IIC基礎介面參考

實作於 mcxa153::core::CoreIICMaster.

isBusy()

virtual bool hal::serial::IICMaster::isBusy ( void )

pure virtual

檢查總線狀態

傳回值

true 總線忙碌中

false 總線閒置中

實作於 mcxa153::core::CoreIICMaster.

setClock()

virtual void hal::serial::IICMaster::setClock ( uint32 hz )

pure virtual

設定傳輸時脈頻率

參數

hz

目標頻率

實作於 mcxa153::core::CoreIICMaster.

setEventError()

virtual void hal::serial::IICMaster::setEventError ( hal::serial::IICMaster::EventError * event = nullptr )

pure virtual

設定錯誤事件處理器

參數

event

錯誤事件處理器,nullptr取消監聽

實作於 mcxa153::core::CoreIICMaster.

---

此結構(structure) 文件是由下列檔案中產生:

• IICMaster.h