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

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

公開方法(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::IICEventError *event=nullptr) override
	Set the Event Error object.
公開方法(Public Methods) 繼承自 mframe::lang::Interface
virtual	~Interface (void)=default
	Destroy the struct object.
virtual mframe::lang::Object &	getObject (void) override
	取得類Object

函式成員說明文件

abort()

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

pure virtual

傳回值

true

false

實作於 core::CoreIICMaster.

beginRead()

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

pure virtual

開始讀取事件

參數

address

讀取目標地址

傳回值

返回狀態

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

實作於 core::CoreIICMaster.

beginWrite()

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

pure virtual

開始傳輸事件

參數

address

傳輸目標地址

傳回值

返回狀態

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

實作於 core::CoreIICMaster.

getClock()

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

pure virtual

取得傳輸速率

傳回值

uint32 hz

實作於 core::CoreIICMaster.

getIIC()

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

pure virtual

取得IIC基類

傳回值

hal::serial::IIC&

實作於 core::CoreIICMaster.

isBusy()

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

pure virtual

取得裝置是否忙碌

傳回值

true 忙碌

false 閒置

實作於 core::CoreIICMaster.

setClock()

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

pure virtual

設定傳輸速率

參數

hz

實作於 core::CoreIICMaster.

setEventError()

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

pure virtual

Set the Event Error object.

參數

event

實作於 core::CoreIICMaster.

---

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

• IICMaster.h