#include "common.h"

Classes
struct	_DW_APB_SSI_REGISTERS

struct	_SERIAL_PORT_MAX311XE

Macros
#define	CRTLR0_SLV_OE (1 << 10)

#define	CTRLR0_TMOD_TX_RX 0

#define	CTRLR0_TMOD_TX (1 << 8)

#define	CTRLR0_TMOD_RX (2 << 8)

#define	CTRLR0_TMOD_EEPROM (3 << 8)

#define	CTRLR0_SCPOL (1 << 7)

#define	CTRLR0_SCPH (1 << 6)

#define	CTRLR0_FRF_MOTOROLA_SPI 0

#define	CTRLR0_FRF_TEXAS_INSTRUMENTS_SSP (1 << 4)

#define	CTRLR0_FRF_NATIONAL_SEMICONDUCTORS_MICROWIRE (2 << 4)

#define	CTRLR0_DFS 15

#define	SSIENR_SSI_EN 1

#define	BAUDR_MAX_RATE 2

#define	BAUDR_OFF 0

#define	SR_DCOL (1 << 6)

#define	SR_TXE (1 << 5)

#define	SR_RFF (1 << 4)

#define	SR_RFNE (1 << 3)

#define	SR_TFE (1 << 2)

#define	SR_TFNF (1 << 1)

#define	SR_BUSY (1 << 0)

#define	MAX311XE_WRITE_CONFIG (3 << 14)

#define	MAX311XE_READ_CONFIG (1 << 14)

#define	MAX311XE_WRITE_DATA (2 << 14)

#define	MAX311XE_READ_DATA 0

#define	MAX311XE_WC_FEN_BAR (1 << 13)

#define	MAX311XE_WC_SHDNI (1 << 12)

#define	MAX311XE_WC_TM_BAR (1 << 11)

#define	MAX311XE_WC_RM_BAR (1 << 10)

#define	MAX311XE_WC_PM_BAR (1 << 9)

#define	MAX311XE_WC_RAM_BAR (1 << 8)

#define	MAX311XE_WC_IRDA (1 << 7)

#define	MAX311XE_WC_ST (1 << 6)

#define	MAX311XE_WC_PE (1 << 5)

#define	MAX311XE_WC_L (1 << 4)

#define	MAX311XE_WC_DIV_1 0

#define	MAX311XE_WC_DIV_2 1

#define	MAX311XE_WC_DIV_4 2

#define	MAX311XE_WC_DIV_8 3

#define	MAX311XE_WC_DIV_16 4

#define	MAX311XE_WC_DIV_32 5

#define	MAX311XE_WC_DIV_64 6

#define	MAX311XE_WC_DIV_128 7

#define	MAX311XE_WC_DIV_3 8

#define	MAX311XE_WC_DIV_6 9

#define	MAX311XE_WC_DIV_12 10

#define	MAX311XE_WC_DIV_24 11

#define	MAX311XE_WC_DIV_48 12

#define	MAX311XE_WC_DIV_96 13

#define	MAX311XE_WC_DIV_192 14

#define	MAX311XE_WC_DIV_384 15

#define	MAX311XE_RC_R (1 << 15)

#define	MAX311XE_RC_T (1 << 14)

#define	MAX311XE_RC_FEN_BAR (1 << 13)

#define	MAX311XE_RC_SHDNI (1 << 12)

#define	MAX311XE_RC_TM_BAR (1 << 11)

#define	MAX311XE_RC_RM_BAR (1 << 10)

#define	MAX311XE_RC_PM_BAR (1 << 9)

#define	MAX311XE_RC_RAM_BAR (1 << 8)

#define	MAX311XE_RC_IRDA (1 << 7)

#define	MAX311XE_RC_ST (1 << 6)

#define	MAX311XE_RC_PE (1 << 5)

#define	MAX311XE_RC_L (1 << 4)

#define	MAX311XE_RC_DIV_1 0

#define	MAX311XE_RC_DIV_2 1

#define	MAX311XE_RC_DIV_4 2

#define	MAX311XE_RC_DIV_8 3

#define	MAX311XE_RC_DIV_16 4

#define	MAX311XE_RC_DIV_32 5

#define	MAX311XE_RC_DIV_64 6

#define	MAX311XE_RC_DIV_128 7

#define	MAX311XE_RC_DIV_3 8

#define	MAX311XE_RC_DIV_6 9

#define	MAX311XE_RC_DIV_12 10

#define	MAX311XE_RC_DIV_24 11

#define	MAX311XE_RC_DIV_48 12

#define	MAX311XE_RC_DIV_96 13

#define	MAX311XE_RC_DIV_192 14

#define	MAX311XE_RC_DIV_384 15

#define	MAX311XE_WD_TE_BAR (1 << 10)

#define	MAX311XE_WD_RTS_BAR (1 << 9)

#define	MAX311XE_WD_PT (1 << 8)

#define	MAX311XE_WD_DATA 0xFF

#define	MAX311XE_RD_R (1 << 15)

#define	MAX311XE_RD_T (1 << 14)

#define	MAX311XE_RD_RA_FE (1 << 10)

#define	MAX311XE_RD_CTS (1 << 9)

#define	MAX311XE_RD_PR (1 << 8)

#define	MAX311XE_RD_DATA 0xFF

#define	SELECTOR_LED 1

#define	SELECTOR_UART 2

#define	SELECTOR_2MB_FLASH 4

#define	RECEIVE_BUFFER_SIZE 1024

Typedefs
typedef struct _DW_APB_SSI_REGISTERS	DW_APB_SSI_REGISTERS

typedef struct _DW_APB_SSI_REGISTERS *	PDW_APB_SSI_REGISTERS

typedef struct _SERIAL_PORT_MAX311XE	SERIAL_PORT_MAX311XE

typedef struct _SERIAL_PORT_MAX311XE *	PSERIAL_PORT_MAX311XE

Functions
BOOLEAN	SpiMax311SetBaud (_Inout_ PCPPORT Port, ULONG Rate)

VOID	SpiInit (_Inout_ PDW_APB_SSI_REGISTERS Spi, UINT16 ControlRegister0, UINT16 ControlRegister1, UINT16 BaudRateRegister)

UINT16	SpiSend16 (_In_ PCPPORT Port, UINT16 Value)

VOID	SpiMax311BufferRxData (UINT16 Value)

BOOLEAN	SpiMax311TxEmpty (_In_ PCPPORT Port)

BOOLEAN	SpiMax311InitializePort (_In_opt_ _Null_terminated_ PCHAR LoadOptions, _Inout_ PCPPORT Port, BOOLEAN MemoryMapped, UCHAR AccessSize, UCHAR BitWidth)

UART_STATUS	SpiMax311GetByte (_Inout_ PCPPORT Port, _Out_ PUCHAR Byte)

UART_STATUS	SpiMax311PutByte (_Inout_ PCPPORT Port, UCHAR Byte, BOOLEAN BusyWait)

BOOLEAN	SpiMax311RxReady (_In_ PCPPORT Port)

Variables
UART_HARDWARE_DRIVER	SpiMax311HardwareDriver

Macro Definition Documentation

◆ BAUDR_MAX_RATE

#define BAUDR_MAX_RATE 2

◆ BAUDR_OFF

#define BAUDR_OFF 0

◆ CRTLR0_SLV_OE

#define CRTLR0_SLV_OE (1 << 10)

◆ CTRLR0_DFS

#define CTRLR0_DFS 15

◆ CTRLR0_FRF_MOTOROLA_SPI

#define CTRLR0_FRF_MOTOROLA_SPI 0

◆ CTRLR0_FRF_NATIONAL_SEMICONDUCTORS_MICROWIRE

#define CTRLR0_FRF_NATIONAL_SEMICONDUCTORS_MICROWIRE (2 << 4)

◆ CTRLR0_FRF_TEXAS_INSTRUMENTS_SSP

#define CTRLR0_FRF_TEXAS_INSTRUMENTS_SSP (1 << 4)

◆ CTRLR0_SCPH

#define CTRLR0_SCPH (1 << 6)

◆ CTRLR0_SCPOL

#define CTRLR0_SCPOL (1 << 7)

◆ CTRLR0_TMOD_EEPROM

#define CTRLR0_TMOD_EEPROM (3 << 8)

◆ CTRLR0_TMOD_RX

#define CTRLR0_TMOD_RX (2 << 8)

◆ CTRLR0_TMOD_TX

#define CTRLR0_TMOD_TX (1 << 8)

◆ CTRLR0_TMOD_TX_RX

#define CTRLR0_TMOD_TX_RX 0

◆ MAX311XE_RC_DIV_1

#define MAX311XE_RC_DIV_1 0

◆ MAX311XE_RC_DIV_12

#define MAX311XE_RC_DIV_12 10

◆ MAX311XE_RC_DIV_128

#define MAX311XE_RC_DIV_128 7

◆ MAX311XE_RC_DIV_16

#define MAX311XE_RC_DIV_16 4

◆ MAX311XE_RC_DIV_192

#define MAX311XE_RC_DIV_192 14

◆ MAX311XE_RC_DIV_2

#define MAX311XE_RC_DIV_2 1

◆ MAX311XE_RC_DIV_24

#define MAX311XE_RC_DIV_24 11

◆ MAX311XE_RC_DIV_3

#define MAX311XE_RC_DIV_3 8

◆ MAX311XE_RC_DIV_32

#define MAX311XE_RC_DIV_32 5

◆ MAX311XE_RC_DIV_384

#define MAX311XE_RC_DIV_384 15

◆ MAX311XE_RC_DIV_4

#define MAX311XE_RC_DIV_4 2

◆ MAX311XE_RC_DIV_48

#define MAX311XE_RC_DIV_48 12

◆ MAX311XE_RC_DIV_6

#define MAX311XE_RC_DIV_6 9

◆ MAX311XE_RC_DIV_64

#define MAX311XE_RC_DIV_64 6

◆ MAX311XE_RC_DIV_8

#define MAX311XE_RC_DIV_8 3

◆ MAX311XE_RC_DIV_96

#define MAX311XE_RC_DIV_96 13

◆ MAX311XE_RC_FEN_BAR

#define MAX311XE_RC_FEN_BAR (1 << 13)

◆ MAX311XE_RC_IRDA

#define MAX311XE_RC_IRDA (1 << 7)

◆ MAX311XE_RC_L

#define MAX311XE_RC_L (1 << 4)

◆ MAX311XE_RC_PE

#define MAX311XE_RC_PE (1 << 5)

◆ MAX311XE_RC_PM_BAR

#define MAX311XE_RC_PM_BAR (1 << 9)

◆ MAX311XE_RC_R

#define MAX311XE_RC_R (1 << 15)

◆ MAX311XE_RC_RAM_BAR

#define MAX311XE_RC_RAM_BAR (1 << 8)

◆ MAX311XE_RC_RM_BAR

#define MAX311XE_RC_RM_BAR (1 << 10)

◆ MAX311XE_RC_SHDNI

#define MAX311XE_RC_SHDNI (1 << 12)

◆ MAX311XE_RC_ST

#define MAX311XE_RC_ST (1 << 6)

◆ MAX311XE_RC_T

#define MAX311XE_RC_T (1 << 14)

◆ MAX311XE_RC_TM_BAR

#define MAX311XE_RC_TM_BAR (1 << 11)

◆ MAX311XE_RD_CTS

#define MAX311XE_RD_CTS (1 << 9)

◆ MAX311XE_RD_DATA

#define MAX311XE_RD_DATA 0xFF

◆ MAX311XE_RD_PR

#define MAX311XE_RD_PR (1 << 8)

◆ MAX311XE_RD_R

#define MAX311XE_RD_R (1 << 15)

◆ MAX311XE_RD_RA_FE

#define MAX311XE_RD_RA_FE (1 << 10)

◆ MAX311XE_RD_T

#define MAX311XE_RD_T (1 << 14)

◆ MAX311XE_READ_CONFIG

#define MAX311XE_READ_CONFIG (1 << 14)

◆ MAX311XE_READ_DATA

#define MAX311XE_READ_DATA 0

◆ MAX311XE_WC_DIV_1

#define MAX311XE_WC_DIV_1 0

◆ MAX311XE_WC_DIV_12

#define MAX311XE_WC_DIV_12 10

◆ MAX311XE_WC_DIV_128

#define MAX311XE_WC_DIV_128 7

◆ MAX311XE_WC_DIV_16

#define MAX311XE_WC_DIV_16 4

◆ MAX311XE_WC_DIV_192

#define MAX311XE_WC_DIV_192 14

◆ MAX311XE_WC_DIV_2

#define MAX311XE_WC_DIV_2 1

◆ MAX311XE_WC_DIV_24

#define MAX311XE_WC_DIV_24 11

◆ MAX311XE_WC_DIV_3

#define MAX311XE_WC_DIV_3 8

◆ MAX311XE_WC_DIV_32

#define MAX311XE_WC_DIV_32 5

◆ MAX311XE_WC_DIV_384

#define MAX311XE_WC_DIV_384 15

◆ MAX311XE_WC_DIV_4

#define MAX311XE_WC_DIV_4 2

◆ MAX311XE_WC_DIV_48

#define MAX311XE_WC_DIV_48 12

◆ MAX311XE_WC_DIV_6

#define MAX311XE_WC_DIV_6 9

◆ MAX311XE_WC_DIV_64

#define MAX311XE_WC_DIV_64 6

◆ MAX311XE_WC_DIV_8

#define MAX311XE_WC_DIV_8 3

◆ MAX311XE_WC_DIV_96

#define MAX311XE_WC_DIV_96 13

◆ MAX311XE_WC_FEN_BAR

#define MAX311XE_WC_FEN_BAR (1 << 13)

◆ MAX311XE_WC_IRDA

#define MAX311XE_WC_IRDA (1 << 7)

◆ MAX311XE_WC_L

#define MAX311XE_WC_L (1 << 4)

◆ MAX311XE_WC_PE

#define MAX311XE_WC_PE (1 << 5)

◆ MAX311XE_WC_PM_BAR

#define MAX311XE_WC_PM_BAR (1 << 9)

◆ MAX311XE_WC_RAM_BAR

#define MAX311XE_WC_RAM_BAR (1 << 8)

◆ MAX311XE_WC_RM_BAR

#define MAX311XE_WC_RM_BAR (1 << 10)

◆ MAX311XE_WC_SHDNI

#define MAX311XE_WC_SHDNI (1 << 12)

◆ MAX311XE_WC_ST

#define MAX311XE_WC_ST (1 << 6)

◆ MAX311XE_WC_TM_BAR

#define MAX311XE_WC_TM_BAR (1 << 11)

◆ MAX311XE_WD_DATA

#define MAX311XE_WD_DATA 0xFF

◆ MAX311XE_WD_PT

#define MAX311XE_WD_PT (1 << 8)

◆ MAX311XE_WD_RTS_BAR

#define MAX311XE_WD_RTS_BAR (1 << 9)

◆ MAX311XE_WD_TE_BAR

#define MAX311XE_WD_TE_BAR (1 << 10)

◆ MAX311XE_WRITE_CONFIG

#define MAX311XE_WRITE_CONFIG (3 << 14)

◆ MAX311XE_WRITE_DATA

#define MAX311XE_WRITE_DATA (2 << 14)

◆ RECEIVE_BUFFER_SIZE

#define RECEIVE_BUFFER_SIZE 1024

◆ SELECTOR_2MB_FLASH

#define SELECTOR_2MB_FLASH 4

◆ SELECTOR_LED

#define SELECTOR_LED 1

◆ SELECTOR_UART

#define SELECTOR_UART 2

◆ SR_BUSY

#define SR_BUSY (1 << 0)

◆ SR_DCOL

#define SR_DCOL (1 << 6)

◆ SR_RFF

#define SR_RFF (1 << 4)

◆ SR_RFNE

#define SR_RFNE (1 << 3)

◆ SR_TFE

#define SR_TFE (1 << 2)

◆ SR_TFNF

#define SR_TFNF (1 << 1)

◆ SR_TXE

#define SR_TXE (1 << 5)

◆ SSIENR_SSI_EN

#define SSIENR_SSI_EN 1

Typedef Documentation

◆ DW_APB_SSI_REGISTERS

typedef struct _DW_APB_SSI_REGISTERS DW_APB_SSI_REGISTERS

◆ PDW_APB_SSI_REGISTERS

typedef struct _DW_APB_SSI_REGISTERS * PDW_APB_SSI_REGISTERS

◆ PSERIAL_PORT_MAX311XE

typedef struct _SERIAL_PORT_MAX311XE * PSERIAL_PORT_MAX311XE

◆ SERIAL_PORT_MAX311XE

typedef struct _SERIAL_PORT_MAX311XE SERIAL_PORT_MAX311XE

Function Documentation

◆ SpiInit()

VOID SpiInit	(	_Inout_ PDW_APB_SSI_REGISTERS	Spi,
		UINT16	ControlRegister0,
		UINT16	ControlRegister1,
		UINT16	BaudRateRegister )

{
    UINT16 Isr;
    UINT16 Risr;
    ULONG  SpiStatus;
 
    //
    // Wait until the SPI is idle.
    //
 
    do
    {
        SpiStatus = READ_REGISTER_ULONG(&(Spi->Sr));
        SpiStatus &= SR_BUSY | SR_TFE;
    } while (SpiStatus != SR_TFE);
 
    //
    // Remove any data not read during the previous transaction.
    //
 
    SpiStatus = READ_REGISTER_ULONG(&(Spi->Sr)) & SR_RFNE;
    while (SpiStatus != 0)
    {
        //
        // Discard the previous transaction's data.
        //
 
        READ_REGISTER_ULONG(&(Spi->Dr));
        SpiStatus = READ_REGISTER_ULONG(&(Spi->Sr)) & SR_RFNE;
    }
 
    //
    // Deselect the previous chip by writing 0 into the Slave Enable Register.
    //
 
    WRITE_REGISTER_ULONG(&(Spi->Ser), 0);
 
    //
    // Disable the SPI controller by writing 0 into the Enable register.
    //
 
    WRITE_REGISTER_ULONG(&(Spi->Ssienr), 0);
 
    //
    // Initialize the SPI controller. Control Register 0 receives the type and
    // bits per single transfer. Control Register 1 receives the number of bytes
    // to receive. Baudr receives the baud rate. Note that the controller must
    // be disabled when programming these registers.
    //
 
    WRITE_REGISTER_ULONG(&(Spi->Ctrlr0), ControlRegister0);
    WRITE_REGISTER_ULONG(&(Spi->Ctrlr1), ControlRegister1);
    WRITE_REGISTER_ULONG(&(Spi->Baudr), BaudRateRegister);
 
    //
    // Clear any pending interrupts in the SPI controller.
    //
 
    do
    {
        Risr = (UINT16)READ_REGISTER_ULONG(&(Spi->Risr));
        Isr  = (UINT16)READ_REGISTER_ULONG(&(Spi->Isr));
    } while ((Risr != 0) || (Isr != 0));
 
    //
    // Enable the SPI controller by writing 1 into the Enable Register.
    //
 
    WRITE_REGISTER_ULONG(&(Spi->Ssienr), 1);
}

◆ SpiMax311BufferRxData()

VOID SpiMax311BufferRxData ( UINT16 Value )

{
    ULONG   NextHead;
    PUINT16 RxBufferHead;
 
    //
    // A receive character is available. Buffer this character for a later
    // receive operation.
    //
 
    RxBufferHead = Max311.RxBuffer + Max311.RxBufferFill;
    NextHead     = (Max311.RxBufferFill + 1) % RECEIVE_BUFFER_SIZE;
    if (NextHead != Max311.RxBufferDrain)
    {
        *RxBufferHead       = Value;
        Max311.RxBufferFill = NextHead;
    }
}

◆ SpiMax311GetByte()

UART_STATUS SpiMax311GetByte	(	_Inout_ PCPPORT	Port,
		_Out_ PUCHAR	Byte )

{
    PUINT16 RxBufferTail;
    UINT16  Value;
 
    if ((Port == NULL) || (Port->Address == NULL))
    {
        return UartNotReady;
    }
 
    //
    // Empty the receive buffer first.
    //
 
    if (Max311.RxBufferDrain != Max311.RxBufferFill)
    {
        //
        // Get the next value from the receive buffer, and move the buffer
        // pointer.
        //
 
        RxBufferTail         = Max311.RxBuffer + Max311.RxBufferDrain;
        Value                = *RxBufferTail;
        *Byte                = (UCHAR)Value;
        Max311.RxBufferDrain = (Max311.RxBufferDrain + 1) % RECEIVE_BUFFER_SIZE;
 
        //
        // Return unsuccessfully if any errors are indicated.
        //
 
        if (CHECK_FLAG(Value, MAX311XE_RD_RA_FE) != FALSE)
        {
            return UartError;
        }
 
        return UartSuccess;
    }
 
    //
    // The receive buffer is empty, so go to the physical device.
    // Read the byte from the UART.
    //
 
    Value = SpiSend16(Port, MAX311XE_READ_DATA);
    if (CHECK_FLAG(Value, MAX311XE_RD_R) != 0)
    {
        //
        // Return unsuccessfully if any errors are indicated.
        //
 
        *Byte = (UCHAR)Value;
        if (CHECK_FLAG(Value, MAX311XE_RD_RA_FE) != FALSE)
        {
            return UartError;
        }
 
        return UartSuccess;
    }
 
    return UartNoData;
}

◆ SpiMax311InitializePort()

BOOLEAN SpiMax311InitializePort	(	_In_opt_ _Null_terminated_ PCHAR	LoadOptions,
		_Inout_ PCPPORT	Port,
		BOOLEAN	MemoryMapped,
		UCHAR	AccessSize,
		UCHAR	BitWidth )

{
    PDW_APB_SSI_REGISTERS Spi;
 
    UNREFERENCED_PARAMETER(LoadOptions);
    UNREFERENCED_PARAMETER(MemoryMapped);
    UNREFERENCED_PARAMETER(AccessSize);
    UNREFERENCED_PARAMETER(BitWidth);
 
    Port->Flags = 0;
 
    //
    // Discard any previously buffered data.
    //
 
    Max311.RxBufferDrain = 0;
    Max311.RxBufferFill  = 0;
 
    //
    // Store the current SPI Baud Rate register value. It is assumed that the
    // firmware set this up to work correctly with the debugging device.
    //
 
    Spi                = (PDW_APB_SSI_REGISTERS)Port->Address;
    Max311.SpiBaudRate = (UINT16)Spi->Baudr;
 
    //
    // Initialize the hardware.
    //
 
    SpiMax311SetBaud(Port, Port->BaudRate);
    return TRUE;
}

◆ SpiMax311PutByte()

UART_STATUS SpiMax311PutByte	(	_Inout_ PCPPORT	Port,
		UCHAR	Byte,
		BOOLEAN	BusyWait )

{
    UINT16 Value;
 
    if ((Port == NULL) || (Port->Address == NULL))
    {
        return UartNotReady;
    }
 
    //
    // Wait for the port to be not busy.
    //
 
    if (BusyWait != FALSE)
    {
        while (!SpiMax311TxEmpty(Port))
            ;
    }
    else if (!SpiMax311TxEmpty(Port))
    {
        return UartNotReady;
    }
 
    //
    // The transmitter buffer is now clear, send the character.
    //
 
    Value = SpiSend16(Port, (UINT16)Byte | MAX311XE_WRITE_DATA);
 
    //
    // Buffer any receive data.
    //
 
    while (TRUE)
    {
        //
        // Exit the loop if no receive data came through.
        //
 
        if (CHECK_FLAG(Value, MAX311XE_RD_R) == 0)
        {
            break;
        }
 
        //
        // Buffer any receive data.
        //
 
        SpiMax311BufferRxData(Value);
 
        //
        // Get the receive buffer status from the UART.
        //
 
        Value = SpiSend16(Port, MAX311XE_READ_DATA);
    }
 
    return UartSuccess;
}

◆ SpiMax311RxReady()

BOOLEAN SpiMax311RxReady ( _In_ PCPPORT Port )

{
    UINT16 Value;
 
    if ((Port == NULL) || (Port->Address == NULL))
    {
        return FALSE;
    }
 
    //
    // Buffer any receive data.
    //
 
    while (TRUE)
    {
        //
        // Get the receive buffer status from the UART.
        //
 
        Value = SpiSend16(Port, MAX311XE_READ_DATA);
 
        //
        // Exit the loop if no receive data came through.
        //
 
        if (CHECK_FLAG(Value, MAX311XE_RD_R) == 0)
        {
            break;
        }
 
        //
        // Buffer any received data.
        //
 
        SpiMax311BufferRxData(Value);
    }
 
    //
    // Determine if there is a received character waiting in the buffer.
    //
 
    if (Max311.RxBufferFill != Max311.RxBufferDrain)
    {
        return TRUE;
    }
 
    return FALSE;
}

◆ SpiMax311SetBaud()

BOOLEAN SpiMax311SetBaud	(	_Inout_ PCPPORT	Port,
		ULONG	Rate )

{
    UINT16 ConfigValue;
 
    if ((Port == NULL) || (Port->Address == NULL))
    {
        return FALSE;
    }
 
    //
    // Select the baud rate
    //
 
    switch (Rate)
    {
    case 230400:
        ConfigValue = MAX311XE_WC_DIV_1;
        break;
 
    default:
        __fallthrough;
 
    case 115200:
        ConfigValue = MAX311XE_WC_DIV_2;
        break;
 
    case 76800:
        ConfigValue = MAX311XE_WC_DIV_3;
        break;
 
    case 57600:
        ConfigValue = MAX311XE_WC_DIV_4;
        break;
 
    case 38400:
        ConfigValue = MAX311XE_WC_DIV_6;
        break;
 
    case 28800:
        ConfigValue = MAX311XE_WC_DIV_8;
        break;
 
    case 19200:
        ConfigValue = MAX311XE_WC_DIV_12;
        break;
 
    case 14400:
        ConfigValue = MAX311XE_WC_DIV_16;
        break;
 
    case 9600:
        ConfigValue = MAX311XE_WC_DIV_24;
        break;
 
    case 7200:
        ConfigValue = MAX311XE_WC_DIV_32;
        break;
 
    case 4800:
        ConfigValue = MAX311XE_WC_DIV_48;
        break;
 
    case 3600:
        ConfigValue = MAX311XE_WC_DIV_64;
        break;
 
    case 2400:
        ConfigValue = MAX311XE_WC_DIV_96;
        break;
 
    case 1800:
        ConfigValue = MAX311XE_WC_DIV_128;
        break;
 
    case 1200:
        ConfigValue = MAX311XE_WC_DIV_192;
        break;
 
    case 600:
        ConfigValue = MAX311XE_WC_DIV_384;
        break;
    }
 
    //
    // Configure the UART for 8 data bits, no parity, 1 stop bit (8N1).
    //
 
    ConfigValue |= MAX311XE_WRITE_CONFIG;
    SpiSend16(Port, ConfigValue);
    Port->BaudRate = Rate;
    return TRUE;
}

◆ SpiMax311TxEmpty()

BOOLEAN SpiMax311TxEmpty ( _In_ PCPPORT Port )

{
    UINT16 Value;
 
    //
    // Buffer any receive data.
    //
 
    while (TRUE)
    {
        //
        // Get the transmit buffer status from the UART.
        //
 
        Value = SpiSend16(Port, MAX311XE_READ_DATA);
 
        //
        // Exit the loop if no receive data.
        //
 
        if (CHECK_FLAG(Value, MAX311XE_RD_R) == 0)
        {
            break;
        }
 
        //
        // Buffer any received data.
        //
 
        SpiMax311BufferRxData(Value);
    }
 
    //
    // Determine if there is space in the transmit buffer.
    //
 
    if (CHECK_FLAG(Value, MAX311XE_RD_T) != 0)
    {
        return TRUE;
    }
 
    return FALSE;
}

◆ SpiSend16()

UINT16 SpiSend16	(	_In_ PCPPORT	Port,
		UINT16	Value )

{
    UINT32                Data;
    PDW_APB_SSI_REGISTERS Spi;
    ULONG                 SpiStatus;
 
    //
    // Locate the SPI controller.
    //
 
    Spi = (PDW_APB_SSI_REGISTERS)Port->Address;
 
    //
    // Initialize the SPI controller. The value for Control Register 0 indicates
    // to both send and receive data, and to send 16 bits per transfer. The
    // baud rate register is for the SPI controller, not the UART.
    //
 
    SpiInit(Spi,
            CTRLR0_TMOD_TX_RX | (16 - 1),
            0,
            Max311.SpiBaudRate);
 
    //
    // Select the UART device on the SPI bus.
    //
 
    WRITE_REGISTER_ULONG(&(Spi->Ser), SELECTOR_UART);
 
    //
    // Write the value to the UART.
    //
 
    WRITE_REGISTER_ULONG(&(Spi->Dr), Value);
 
    //
    // Wait until the SPI operation is complete.
    //
 
    do
    {
        SpiStatus = READ_REGISTER_ULONG(&(Spi->Sr));
        SpiStatus &= SR_BUSY | SR_TFE | SR_RFNE;
 
    } while (SpiStatus != (SR_TFE | SR_RFNE));
 
    //
    // Read the data value that came in as a result of the send.
    //
 
    Data = READ_REGISTER_ULONG(&(Spi->Dr));
    return (UINT16)Data;
}

Variable Documentation

◆ SpiMax311HardwareDriver

UART_HARDWARE_DRIVER SpiMax311HardwareDriver

Initial value:

= {
    SpiMax311InitializePort,
    SpiMax311SetBaud,
    SpiMax311GetByte,
    SpiMax311PutByte,
    SpiMax311RxReady}

                                               {
    SpiMax311InitializePort,
    SpiMax311SetBaud,
    SpiMax311GetByte,
    SpiMax311PutByte,
    SpiMax311RxReady};

Classes

Macros

Typedefs

Functions

Variables