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

[Interface]硬體抽象層，同步非同步收發器。 更多...

#include <UART.h>

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

公開方法(Public Methods)
virtual uint32	setBaudrate (uint32 baudrate) override
	設定UART Baudrate，返回值為設定後的數值。 隨核心頻率不同，可能只能產生相近的Baudrate
virtual uint32	getBaudrate (void) override
	取得UART Baudrate
virtual void	beginTransfer (bool enable) override
	設定UART開始或關閉輸出緩衝器空事件監聽，當輸出緩存為空時將會呼叫Event::onUartTransfer
virtual void	beginReceiver (bool enable) override
	設定UART開始或關閉接收緩衝器滿事件監聽，當有新資料接收成功後將會呼叫Event::onUartReceiver
virtual void	setEventReceiver (UARTEventReceiver *event) override
	設定UART事件物件，當參數為nullptr時取消監聽與事件。
virtual void	setEventTransfer (UARTEventTransfer *event) override
	設定UART事件物件，當參數為nullptr時取消監聽與事件。
公開方法(Public Methods) 繼承自 hal::Base
virtual bool	deinit (void) override
	硬體去初始化。
virtual bool	init (void) override
	硬體初始化。
virtual bool	isInit (void) override
	取得硬體是否已初始化。
公開方法(Public Methods) 繼承自 mframe::lang::Interface
virtual	~Interface (void)=default
	Destroy the struct object.
virtual mframe::lang::Object &	getObject (void) override
	取得類Object

詳細描述

[Interface]硬體抽象層，同步非同步收發器。

函式成員說明文件

beginReceiver()

virtual void hal::serial::UART::beginReceiver ( bool enable )

pure virtual

設定UART開始或關閉接收緩衝器滿事件監聽，當有新資料接收成功後將會呼叫Event::onUartReceiver

參數

enable

- true為開始監聽，false則否

實作於 core::CoreUSART.

beginTransfer()

virtual void hal::serial::UART::beginTransfer ( bool enable )

pure virtual

設定UART開始或關閉輸出緩衝器空事件監聽，當輸出緩存為空時將會呼叫Event::onUartTransfer

參數

enable

- true為開始監聽，false則否

實作於 core::CoreUSART.

getBaudrate()

virtual uint32 hal::serial::UART::getBaudrate ( void )

pure virtual

取得UART Baudrate

傳回值

uint32 Baudrate

實作於 core::CoreUSART.

setBaudrate()

virtual uint32 hal::serial::UART::setBaudrate ( uint32 baudrate )

pure virtual

設定UART Baudrate，返回值為設定後的數值。 隨核心頻率不同，可能只能產生相近的Baudrate

參數

baudrate

預期的Baudrate

傳回值

uint32 隨設備頻率所產生的Baudrate

實作於 core::CoreUSART.

setEventReceiver()

virtual void hal::serial::UART::setEventReceiver ( UARTEventReceiver * event )

pure virtual

設定UART事件物件，當參數為nullptr時取消監聽與事件。

參數

event

事件，可為nullptr

實作於 core::CoreUSART.

setEventTransfer()

virtual void hal::serial::UART::setEventTransfer ( UARTEventTransfer * event )

pure virtual

設定UART事件物件，當參數為nullptr時取消監聽與事件。

參數

event

事件，可為nullptr

實作於 core::CoreUSART.

---

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

• UART.h