RS232 Namespace Reference

Functions
int	vprintf (const char *fmt, va_list args)
int	printf (const char *format,...)
void	init (uint16_t com_id)
size_t	read (char *buf, size_t count)
size_t	write (const char *buf, size_t count)
int	close ()

Function Documentation

close()

int RS232::close

(

)

Closes the serial input buffer and frees all of the data contained within.

Returns

int Returns 0 on success and -1 on error. Errno is set appropriately.

Definition at line 168 of file rs232.cpp.

{
    return 0;
}

init()

void RS232::init

(

uint16_t

com_id

)

Activates the RS232 serial driver.

Definition at line 112 of file rs232.cpp.

{
    // Register the IRQ callback
    rs_232_port_base = com_id;
    uint8_t IRQ = 0x20 + (com_id == RS_232_COM1 ? RS_232_COM1_IRQ : RS_232_COM2_IRQ);
    Interrupts::registerHandler(IRQ, callback);
    // Write the port data to activate the device
    // disable interrupts
    writeByte(rs_232_port_base + RS_232_INTERRUPT_ENABLE_REG, 0x00);
    writeByte(rs_232_port_base + RS_232_LINE_CONTROL_REG, 0x80);
    writeByte(rs_232_port_base + RS_232_DATA_REG, 0x03);
    writeByte(rs_232_port_base + RS_232_INTERRUPT_ENABLE_REG, 0x00);
    writeByte(rs_232_port_base + RS_232_LINE_CONTROL_REG, 0x03);
    writeByte(rs_232_port_base + RS_232_INTERRUPT_IDENTIFICATION_REG, 0xC7);
    writeByte(rs_232_port_base + RS_232_MODEM_CONTROL_REG, 0x0B);
    writeByte(rs_232_port_base + RS_232_LINE_CONTROL_REG, 0x00);
    // re-enable interrupts
    writeByte(rs_232_port_base + RS_232_INTERRUPT_ENABLE_REG, 0x01);
 
    Logger::addWriter(vprintf);
    Logger::Print(
        "\033[93m\n"
        "   _  __           _              _____\n"
        "  | |/ /_  _______(_)____   _   _|__  /\n"
        "  |   / / / / ___/ / ___/  | | / //_ <\n"
        " /   / /_/ / /  / (__  )   | |/ /__/ /\n"
        "/_/|_\\__, /_/  /_/____/    |___/____/\n"
        "    /____/\n"
        "\n\033[0m"
        "Xyris Serial Output Debugger\n\n");
}

Here is the call graph for this function:

printf()

int RS232::printf	(	const char *	format,
			...
	)

Prints a formatted string to serial output.

Parameters

format	Format string
...	Arguments

Returns

int Number of characters printed

Definition at line 86 of file rs232.cpp.

{
    va_list args;
    int ret_val;
 
    va_start(args, format);
    ret_val = vprintf(format, args);
    va_end(args);
    return ret_val;
}

Here is the call graph for this function:

read()

size_t RS232::read	(	char *	buf,
		size_t	count
	)

Reads bytes from the serial buffer.

Parameters

buf	Buffer to hold the serial input
count	Number of bytes to read

Returns

char* Returns the number of bytes read.

Definition at line 144 of file rs232.cpp.

{
    size_t bytes = 0;
    mutex_rs232.lock();
    for (size_t idx = 0; idx < count && !ring.IsEmpty(); idx++) {
        buf[idx] = ring.Dequeue();
        bytes++;
    }
    mutex_rs232.unlock();
    return bytes;
}

Here is the call graph for this function:

vprintf()

int RS232::vprintf	(	const char *	fmt,
		va_list	args
	)

Prints a formatted string to serial output using a va_list of arguments.

Parameters

fmt	Format string
args	Arguments list

Returns

int Number of characters printed

Definition at line 79 of file rs232.cpp.

{
    int retval;
    retval = printf_helper(fmt, args, vprintf_helper, NULL);
    return retval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

write()

size_t RS232::write	(	const char *	buf,
		size_t	count
	)

Write bytes to the serial device.

Parameters

buf	Buffer containing bytes to write
count	Number of bytes to write

Returns

size_t Returns number of bytes written

Definition at line 156 of file rs232.cpp.

{
    // Wait for previous transfer to complete
    while (is_transmit_empty() == 0);
    size_t bytes = 0;
    for (size_t idx = 0; idx < count; idx++) {
        writeByte(rs_232_port_base + RS_232_DATA_REG, buf[idx]);
        bytes++;
    }
    return bytes;
}

Here is the call graph for this function: