Struct rustduino::atmega2560p::com::usart_initialize::UsartObject

#[repr(C, packed)]
pub struct UsartObject {
    pub usart: *mut Usart,
    pub name: UsartNum,
}

Contains the Usart as a Raw Pointer along with it’s name. This controls a USART as a object for careful implementation.

Fields

usart: *mut Usart

name: UsartNum

Implementations

impl UsartObject

pub unsafe fn begin(&mut self)

Can be use to initialize a USART with default settings.

pub unsafe fn begin_set_baud(&mut self, baud1: i64)

Can be use to initialize with given baud rate and remaining settings will be set to default.

Arguments

• baud1 - a i64, the baud rate of USART the user wants to set.

pub unsafe fn end(&mut self)

Can be used to stop the functioning of initialized USART.

impl UsartObject

pub unsafe fn transmit_enable(&mut self)

Enables the Transmitter, once it is enabled it takes control of the TXDn pin as a transmitting output.

pub unsafe fn transmitting_data(&mut self, data: u32, len: UsartDataSize)

Storing data in Transmit Buffer.

Arguments

• data - a u32, the data to be transmitted.
• len - a UsartDataSize object, which contains the length of data frame of USART.

pub unsafe fn avai_write(&mut self) -> bool

Checks that transmission buffer if ready for transmission.

Returns

• a boolean - Which is true if ready otherwise false.

pub unsafe fn flush_transmit(&mut self)

This waits for the transmission to complete by checking the appropriate register.

pub fn transmit_disable(&mut self)

This is used to disable the Transmitter and once disabled the pins used for USART return into their default I/O pin mode.

pub fn transmit_data(&mut self, data: u8)

Sends a character byte of 5,6,7 or 8 bits.

Arguments

• data - a u8, consisting of the current data frame to send from USART.

pub fn write_string(&mut self, data: &'static str)

Send’s data of type string byte by byte using USART.

Arguments

• data - a static string object, which is to be transmitted using USART.

pub fn write_integer(&mut self, data: u32)

Send’s data of type integer(u32) byte by byte.

Arguments

• data - a u32, which is to be transmitted using USART.

pub fn write_float(&mut self, data: f64, precision: u32)

Send’s data of type float(f64) byte by byte till the precision required.

Arguments

• data - a f32, which is to be transmitted using USART.
• precision - a u32, the number of decimal precision required in the transmission.

impl UsartObject

pub unsafe fn new(num: UsartNum) -> UsartObject

This creates a raw pointer for formation of the serial structure ahead to control all the USARTs of ATMEGA2560P at one place.

Arguments

• num - a UsartNum object, which defines the USART for whom new reference is to be created.

Returns

• a UsartObject - which will be used to control the USART.

impl UsartObject

pub fn disable(&self)

Disable global interrupts for smooth non-interrupted functioning of USART.

pub fn enable(&self)

Re-enable global interrupts.

pub unsafe fn set_polarity(&mut self, mode: UsartPolarity)

Set clock polarity mode according to input from user.

Arguments

• mode - a UsartPolarity object, which will be set for the USART.

pub unsafe fn mode_select(&mut self, mode: UsartModes)

Set’s various modes of the USART which is activated.

Arguments

• mode - a UsartModes object, which will be set for the USART.

pub fn set_power(&mut self, num: UsartNum)

Set’s the power reduction register so that USART functioning is allowed.

Arguments

• num - a UsartNum object, for which the power configurations of the USART will be set.

pub unsafe fn set_txn(&mut self)

Set the appropriate bits for flushing out transmission and recieval.

pub unsafe fn reset(&mut self)

Reset the USART.

pub unsafe fn initialize(
    &mut self,
    mode: UsartModes,
    baud: i64,
    stop: UsartStop,
    size: UsartDataSize,
    parity: UsartParity
)

This is the cumulative function for initializing a particular USART and it will take all the necessary details about the mode in which the USART pin is to be used.

Arguments

• mode - a UsartModes object, which defines the mode of USART to use.
• baud - a i64, the baud rate of USART the user wants to set.
• size - a UsartDatSize object, the size of set of bits to transmit.
• parity - a UsartParity object, which gives the Parity bit mode for USART.
• stop - a UsartStop object, which will be used to set the stop bits of data frame.

impl UsartObject

pub unsafe fn recieve_enable(&mut self)

Enables the reciever function of microcontroller, whithout enabling it no communication is possible.

pub fn available(&mut self) -> bool

Checks if the data is avialable for reading or not.

Returns

• a boolean - Which is false for no reading data and true if everything fine.

pub fn recieve_data(&mut self) -> Option<u32>

This is used to recieve data of one frame. Either 5 to 8 bits and 9 bits of data can be recieved from this function. In case of 5 to 8 bits this function returns u8. In case of 9 bits it retuns u32 of which first 9 bits are data recieved and remaining bits are insignificant. In case if an frame error or parity error occurs, this function returns Nothing.

Returns

• a Option<u32> - which is NULL in case of wrong settings and read data u32 if valid input.

pub fn error_check(&mut self) -> bool

Can be used to check frame error,Data OverRun and Parity errors.

Returns

• a boolean - Which is true if error occurs,else false.

pub fn parity_check(&mut self) -> bool

Can be used to check parity error.

Returns

• a boolean - Which is true if error occurs,else false.

pub unsafe fn recieve_disable(&mut self)

Disables the reciever function of microcontroller.

pub unsafe fn flush_recieve(&mut self)

Clears the unread data in the receive buffer by flushing it

pub fn read(&mut self) -> Option<u32>

This is used to recieve data of one frame. But it only functions when already data is available for read.which can be checked by available function. Either 5 to 8 bits and 9 bits of data can be recieved from this function. In case of 5 to 8 bits this function returns u8. In case of 9 bits it retuns u32 of which first 9 bits are data recieved and remaining bits are insignificant. In case ,if an frame error or parity error occurs, this function returns nothing.

Returns

• a Option<u32> - which is NULL in case of wrong settings and read data u32 if valid input.