RS232-MUX

/* 

 * File: hardware_config.h

 * Author: Enzo Niro

 * Comments: Board configuration library for MUX232

 * Revision history: 1.0

 */

// This is a guard condition so that contents of this file are not included

// more than once.  

#ifndef HARDWARE_CFG_H

#define        HARDWARE_CFG_H

#include <xc.h> // include processor files - each processor file is guarded.  

#include "parameters.h"

typedef struct eepromPort eepromPort;

struct eepromPort

{

    uint8_t regA; // register A for speed and parity configuration

    uint8_t regB; // register B for Data structure and stop bits

};

typedef struct cfgPort cfgPort;

struct cfgPort

{

    uint16_t baud; // Port speed

    uint8_t parity; // Parity for frame structure

    uint8_t dataByte; // Data byte structure

    uint8_t stopBit; // Stop bits for frame structure

};

//EEPROM data structure (for reading registers)

eepromPort eepromVCOM[4];

//Values registers

#define F5BIT_MODE                  0x00

#define F6BIT_MODE                  0x01

#define F7BIT_MODE                  0x02

#define F8BIT_MODE                  0x03

#define AVR32_NO_PARITY             0x00

#define AVR32_ODD_PARITY            0x01        //0x03

#define AVR32_EVEN_PARITY           0x03        //0x02

#define TL16C_NO_PARITY             0x00

#define TL16C_ODD_PARITY            0x01        //0x03

#define TL16C_EVEN_PARITY           0x03        //0x02

#define ONE_STOPBIT                 0x00

#define TWO_STOPBITS                0x01

///////////////////////////

//Divisor Latch values

//According to 8MHz

#ifdef TL16C_8MHZ_CLK

#define DL_9600_BAUDS    52

#define DL_19200_BAUDS   26

#define DL_38400_BAUDS   13

#else

#ifdef TL16C_16MHZ_CLK

#define DL_9600_BAUDS    104

#define DL_19200_BAUDS   52

#define DL_38400_BAUDS   26

#else

#ifdef TL16C_24MHZ_CLK

#define DL_9600_BAUDS    156

#define DL_19200_BAUDS   78

#define DL_38400_BAUDS   39

#else

#error "Please choose a configuration for baud speed"

#define DL_9600_BAUDS    0x0

#define DL_19200_BAUDS   0x0

#define DL_38400_BAUDS   0x0

#define CPU_FREQ_SET     0x0

#endif //24MHZ

#endif //16MHZ

#endif //8MHZ

//EEPROM addresses

enum ADDR_BAUDS

{

    ADDR_BAUD_9600 = 0,

    ADDR_BAUD_19200,

    ADDR_BAUD_38400,

};

enum ADDR_PARITY

{

    ADDR_PARITY_NONE = 0,

    ADDR_PARITY_EVEN,

    ADDR_PARITY_ODD,

};

enum ADDR_DATA

{

    ADDR_DATA_F5 = 0,

    ADDR_DATA_F6,

    ADDR_DATA_F7,

    ADDR_DATA_F8,

};

enum ADDR_STOPBIT

{

    ADDR_STOP_ONE = 0,

    ADDR_STOP_TWO,

};

#define DEFAULT_ADDR_BAUD               ADDR_BAUD_9600

#define DEFAULT_ADDR_PARITY             ADDR_PARITY_NONE

#define DEFAULT_ADDR_DATA               ADDR_DATA_F8

#define DEFAULT_ADDR_STOP               ADDR_STOP_ONE

#define DEFAULT_VALUE_DEBUG_LED         0x1F

#define EEPROM_DEBUG_LED_ADDR           0x8

//////////////////////////////////////////////////

//EEPROM/CFG function

void getEEPROMCfg(void);

void setEEPROMCfg(void);

void writeConfiguration(cfgPort *cfg, uint8_t bauds, uint8_t parity, uint8_t dataMode, uint8_t stopBit, uint8_t n);

void readConfiguration(cfgPort *cfg, uint8_t n);

//////////////////////////////////////////////////

/**

 <p><b>void getEEPROMCfg(void)</b></p>

 <p><b>Read eeprom values stored for all serial ports</b></p>

 */

void getEEPROMCfg(void)

{

    uint8_t i = 0, j = 0;

    while(j < 8)

    {

        //Read at first bytes

        eepromVCOM[i].regA = eeprom_read_byte(j);

        eepromVCOM[i].regB = eeprom_read_byte(j+1);

        //Then check if writing default values is necessary

        if(eepromVCOM[i].regA == 0xFF)

        {

            eepromVCOM[i].regA = (DEFAULT_ADDR_BAUD << 4) | (DEFAULT_ADDR_PARITY);

            eeprom_write_byte(j, (DEFAULT_ADDR_BAUD << 4) | (DEFAULT_ADDR_PARITY));

        }

        if(eepromVCOM[i].regB == 0xFF)

        {

            eepromVCOM[i].regB = (DEFAULT_ADDR_DATA << 4) | (DEFAULT_ADDR_STOP);

            eeprom_write_byte(j+1, (DEFAULT_ADDR_DATA << 4) | (DEFAULT_ADDR_STOP));

        }

        i++;

        j+=2;

    }

}

/**

 <p><b>void getEEPROMCfg(void)</b></p>

 <p><b>Write eeprom values stored for all serial ports</b></p>

 */

void setEEPROMCfg(void)

{

    uint8_t i = 0, j = 0;

    //Write EEPROM cfg

    while(j < 8)

    {

        //Read at first bytes

        eeprom_write_byte(j, eepromVCOM[i].regA);

        eeprom_write_byte(j+1, eepromVCOM[i].regB);

        i++; //next cfg

        j+=2; //next address

    }

}

/**

 <p><b>void readConfiguration(cfgPort *cfg, uint8_t n)</b></p>

 <p><b>Get configuration with eeprom read values</b></p>

 <p><b>             cfgPort -> Serial port configuration</b></p>

 <p><b>             n -> Serial port to configure</b></p>

 */

void readConfiguration(cfgPort *cfg, uint8_t n)

{

    //BAUD value register for these frequencies in this order :

    //2400, 4800, 9600, 19200, 38400, 57600, 115200

    uint16_t speedCfg[] = { DL_9600_BAUDS, DL_19200_BAUDS, DL_38400_BAUDS };

    uint8_t parityCfg[] = { TL16C_NO_PARITY, TL16C_EVEN_PARITY, TL16C_ODD_PARITY };

    uint8_t dataCfg[] = { F5BIT_MODE, F6BIT_MODE, F7BIT_MODE, F8BIT_MODE };

    uint8_t stopCfg[] = { ONE_STOPBIT, TWO_STOPBITS };

    cfg->baud = speedCfg[(eepromVCOM[n].regA >> 4)];

    cfg->parity = parityCfg[(eepromVCOM[n].regA & 0xF)];

    cfg->dataByte = dataCfg[(eepromVCOM[n].regB >> 4)];

    cfg->stopBit = stopCfg[(eepromVCOM[n].regB & 0xF)];

}

/**

 <p><b>void readConfiguration(cfgPort *cfg, uint8_t n)</b></p>

 <p><b>Get configuration with eeprom read values</b></p>

 <p><b>             cfgPort -> Serial port configuration</b></p>

 <p><b>             bauds -> Set bauds speed (9600 / 19200 / 38400)</b></p>

 <p><b>             parity -> Set parity Mode (NO_PARITY / EVEN_PARITY / ODD_PARITY)</b></p>

 <p><b>             dataMode -> Set number of data bits into frame (5/6/7/8)</b></p>

 <p><b>             stopBit -> Set number of stop bits (1/2)</b></p>

 */

void writeConfiguration(cfgPort *cfg, uint8_t bauds, uint8_t parity, uint8_t dataMode, uint8_t stopBit, uint8_t n)

{

    //BAUD value register for these frequencies in this order :

    //2400, 4800, 9600, 19200, 38400, 57600, 115200

    uint16_t speedCfg[] = { DL_9600_BAUDS, DL_19200_BAUDS, DL_38400_BAUDS };

    uint8_t parityCfg[] = { TL16C_NO_PARITY, TL16C_EVEN_PARITY, TL16C_ODD_PARITY };

    uint8_t dataCfg[] = { F5BIT_MODE, F6BIT_MODE, F7BIT_MODE, F8BIT_MODE };

    uint8_t stopCfg[] = { ONE_STOPBIT, TWO_STOPBITS };

    //Set CFG

    cfg->baud = speedCfg[bauds > 2 ? 2 : bauds];

    cfg->parity = parityCfg[parity > 2 ? 2 : parity];

    cfg->dataByte = dataCfg[dataMode > 3 ? 3 : dataMode];

    cfg->stopBit = stopCfg[stopBit > 1 ? 1 : stopBit];

    //Prepare buffer into RAM

    eepromVCOM[n].regA = (cfg->baud << 4) | cfg->parity;

    eepromVCOM[n].regB = (cfg->dataByte << 4) | cfg->stopBit;

}

#endif        /* XC_HEADER_TEMPLATE_H */