skarg
382 lines
11 KiB
C
382 lines
11 KiB
C
/**************************************************************************
|
|
*
|
|
* Copyright (C) 2005 Steve Karg <skarg@users.sourceforge.net>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
*********************************************************************/
|
|
|
|
/* The module handles sending data out the RS-485 port */
|
|
/* and handles receiving data from the RS-485 port. */
|
|
/* Customize this file for your specific hardware */
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <string.h>
|
|
#include "hardware.h"
|
|
#include "mstp.h"
|
|
#include "rs485.h"
|
|
|
|
/* public port info */
|
|
extern volatile struct mstp_port_struct_t MSTP_Port;
|
|
|
|
/* the baud rate is adjustable */
|
|
uint32_t RS485_Baud_Rate = 38400;
|
|
|
|
/* the ISR and other use this for status and control */
|
|
COMSTAT RS485_Comstat;
|
|
|
|
/*#pragma udata MSTPPortData
|
|
*/
|
|
/* the buffer for receiving characters */
|
|
volatile uint8_t RS485_Rx_Buffer[MAX_MPDU];
|
|
|
|
/* UART transmission buffer and index */
|
|
volatile uint8_t RS485_Tx_Buffer[MAX_MPDU];
|
|
|
|
/****************************************************************************
|
|
* DESCRIPTION: Transmits a frame using the UART
|
|
* RETURN: none
|
|
* ALGORITHM: none
|
|
* NOTES: none
|
|
*****************************************************************************/
|
|
void RS485_Send_Frame(volatile struct mstp_port_struct_t *mstp_port, /* port specific data */
|
|
uint8_t * buffer, /* frame to send (up to 501 bytes of data) */
|
|
uint16_t nbytes)
|
|
{ /* number of bytes of data (up to 501) */
|
|
uint16_t i = 0; /* loop counter */
|
|
uint8_t turnaround_time;
|
|
|
|
if (!buffer)
|
|
return;
|
|
|
|
/* bounds check */
|
|
if (nbytes >= sizeof(RS485_Tx_Buffer))
|
|
return;
|
|
|
|
/* buffer is full. Wait for ISR to transmit. */
|
|
while (RS485_Comstat.Tx_Bytes) {
|
|
};
|
|
|
|
/* wait 40 bit times since reception */
|
|
if (RS485_Baud_Rate == 9600)
|
|
turnaround_time = 4;
|
|
else if (RS485_Baud_Rate == 19200)
|
|
turnaround_time = 2;
|
|
else
|
|
turnaround_time = 1;
|
|
|
|
while (mstp_port->SilenceTimer < turnaround_time) {
|
|
};
|
|
|
|
RS485_Comstat.TxHead = 0;
|
|
memcpy((void *) &RS485_Tx_Buffer[0], (void *) buffer, nbytes);
|
|
#if 0
|
|
for (i = 0; i < nbytes; i++) {
|
|
/* put the data into the buffer */
|
|
RS485_Tx_Buffer[i] = *buffer;
|
|
buffer++;
|
|
}
|
|
#endif
|
|
RS485_Comstat.Tx_Bytes = nbytes;
|
|
/* disable the receiver */
|
|
PIE3bits.RC2IE = 0;
|
|
RCSTA2bits.CREN = 0;
|
|
/* enable the transceiver */
|
|
RS485_TX_ENABLE = 1;
|
|
RS485_RX_DISABLE = 1;
|
|
/* enable the transmitter */
|
|
TXSTA2bits.TXEN = 1;
|
|
PIE3bits.TX2IE = 1;
|
|
/* per MSTP spec, sort of */
|
|
mstp_port->SilenceTimer = 0;
|
|
|
|
return;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* DESCRIPTION: Checks for data on the receive UART, and handles errors
|
|
* RETURN: none
|
|
* ALGORITHM: none
|
|
* NOTES: none
|
|
*****************************************************************************/
|
|
uint8_t RS485_Check_UART_Data(volatile struct mstp_port_struct_t *
|
|
mstp_port)
|
|
{
|
|
/* check for data */
|
|
if (RS485_Comstat.Rx_Bytes) {
|
|
mstp_port->DataRegister = RS485_Rx_Buffer[RS485_Comstat.RxTail];
|
|
if (RS485_Comstat.RxTail >= (sizeof(RS485_Rx_Buffer) - 1))
|
|
RS485_Comstat.RxTail = 0;
|
|
else
|
|
RS485_Comstat.RxTail++;
|
|
/* FIXME: disable interrupts around Rx_Bytes */
|
|
RS485_Comstat.Rx_Bytes--;
|
|
/* errors? let the state machine know */
|
|
if (RS485_Comstat.Rx_Bufferoverrun) {
|
|
RS485_Comstat.Rx_Bufferoverrun = FALSE;
|
|
mstp_port->ReceiveError = TRUE;
|
|
}
|
|
/* We read a good byte */
|
|
else
|
|
mstp_port->DataAvailable = TRUE;
|
|
}
|
|
|
|
return RS485_Comstat.Rx_Bytes;
|
|
}
|
|
|
|
/* *************************************************************************
|
|
DESCRIPTION: Receives RS485 data stream
|
|
|
|
RETURN: none
|
|
|
|
ALGORITHM: none
|
|
|
|
NOTES: none
|
|
*************************************************************************** */
|
|
void RS485_Interrupt_Rx(void)
|
|
{
|
|
char dummy;
|
|
|
|
if ((RCSTA2bits.FERR) || (RCSTA2bits.OERR)) {
|
|
/* Clear the error */
|
|
RCSTA2bits.CREN = 0;
|
|
RCSTA2bits.CREN = 1;
|
|
RS485_Comstat.Rx_Bufferoverrun = TRUE;
|
|
dummy = RCREG2;
|
|
} else if (RS485_Comstat.Rx_Bytes < sizeof(RS485_Rx_Buffer)) {
|
|
RS485_Rx_Buffer[RS485_Comstat.RxHead] = RCREG2;
|
|
if (RS485_Comstat.RxHead >= (sizeof(RS485_Rx_Buffer) - 1))
|
|
RS485_Comstat.RxHead = 0;
|
|
else
|
|
RS485_Comstat.RxHead++;
|
|
RS485_Comstat.Rx_Bytes++;
|
|
} else {
|
|
RS485_Comstat.Rx_Bufferoverrun = TRUE;
|
|
dummy = RCREG2;
|
|
(void) dummy;
|
|
}
|
|
}
|
|
|
|
/* *************************************************************************
|
|
DESCRIPTION: Transmits a byte using the UART out the RS485 port
|
|
|
|
RETURN: none
|
|
|
|
ALGORITHM: none
|
|
|
|
NOTES: none
|
|
*************************************************************************** */
|
|
void RS485_Interrupt_Tx(void)
|
|
{
|
|
if (RS485_Comstat.Tx_Bytes) {
|
|
/* Get the data byte */
|
|
TXREG2 = RS485_Tx_Buffer[RS485_Comstat.TxHead];
|
|
/* point to the next byte */
|
|
RS485_Comstat.TxHead++;
|
|
/* reduce the buffer size */
|
|
RS485_Comstat.Tx_Bytes--;
|
|
} else {
|
|
/* wait for the USART to be empty */
|
|
while (!TXSTA2bits.TRMT);
|
|
/* disable this interrupt */
|
|
PIE3bits.TX2IE = 0;
|
|
/* enable the receiver */
|
|
RS485_TX_ENABLE = 0;
|
|
RS485_RX_DISABLE = 0;
|
|
/* FIXME: might not be necessary
|
|
*/
|
|
PIE3bits.RC2IE = 1;
|
|
RCSTA2bits.CREN = 1;
|
|
}
|
|
}
|
|
|
|
/****************************************************************************
|
|
* DESCRIPTION: Returns the baud rate that we are currently running at
|
|
* RETURN: none
|
|
* ALGORITHM: none
|
|
* NOTES: none
|
|
*****************************************************************************/
|
|
uint32_t RS485_Get_Baud_Rate(void)
|
|
{
|
|
return RS485_Baud_Rate;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* DESCRIPTION: Sets the baud rate for the chip USART
|
|
* RETURN: none
|
|
* ALGORITHM: none
|
|
* NOTES: none
|
|
*****************************************************************************/
|
|
bool RS485_Set_Baud_Rate(uint32_t baud)
|
|
{
|
|
bool valid = true;
|
|
|
|
switch (baud) {
|
|
case 9600:
|
|
case 19200:
|
|
case 38400:
|
|
case 57600:
|
|
case 76800:
|
|
case 115200:
|
|
RS485_Baud_Rate = baud;
|
|
break;
|
|
default:
|
|
valid = false;
|
|
break;
|
|
}
|
|
|
|
if (valid) {
|
|
/* FIXME: store the baud rate */
|
|
/* I2C_Write_Block(
|
|
EEPROM_DEVICE_ADDRESS,
|
|
(char *)&RS485_Baud_Rate,
|
|
sizeof(RS485_Baud_Rate),
|
|
EEPROM_MSTP_BAUD_RATE_ADDR); */
|
|
}
|
|
|
|
return valid;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* DESCRIPTION: Initializes the RS485 hardware and variables, and starts in
|
|
* receive mode.
|
|
* RETURN: none
|
|
* ALGORITHM: none
|
|
* NOTES: none
|
|
*****************************************************************************/
|
|
void RS485_Initialize_Port(void)
|
|
{
|
|
|
|
/* Reset USART registers to POR state */
|
|
TXSTA2 = 0;
|
|
RCSTA2 = 0;
|
|
/* configure USART for receiving */
|
|
/* since the TX will handle setting up for transmit */
|
|
RCSTA2bits.CREN = 1;
|
|
/* Interrupt on receipt */
|
|
PIE3bits.RC2IE = 1;
|
|
/* enable the transmitter, disable its interrupt */
|
|
TXSTA2bits.TXEN = 1;
|
|
PIE3bits.TX2IE = 0;
|
|
/* setup USART Baud Rate Generator */
|
|
/* see BAUD RATES FOR ASYNCHRONOUS MODE in Data Book */
|
|
/* Fosc=20MHz
|
|
BRGH=1 BRGH=0
|
|
Rate SPBRG Rate SPBRG
|
|
------- ----- ------- -----
|
|
9615 129 9469 32
|
|
19230 64 19530 15
|
|
37878 32 78130 3
|
|
56818 21 104200 2
|
|
113630 10 312500 0
|
|
250000 4
|
|
625000 1
|
|
1250000 0
|
|
*/
|
|
switch (RS485_Baud_Rate) {
|
|
case 19200:
|
|
SPBRG2 = 64;
|
|
TXSTA2bits.BRGH = 1;
|
|
break;
|
|
case 38400:
|
|
SPBRG2 = 32;
|
|
TXSTA2bits.BRGH = 1;
|
|
break;
|
|
case 57600:
|
|
SPBRG2 = 21;
|
|
TXSTA2bits.BRGH = 1;
|
|
break;
|
|
case 76800:
|
|
SPBRG2 = 3;
|
|
TXSTA2bits.BRGH = 0;
|
|
break;
|
|
case 115200:
|
|
SPBRG2 = 10;
|
|
TXSTA2bits.BRGH = 1;
|
|
break;
|
|
case 9600:
|
|
SPBRG2 = 129;
|
|
TXSTA2bits.BRGH = 1;
|
|
break;
|
|
default:
|
|
SPBRG2 = 129;
|
|
TXSTA2bits.BRGH = 1;
|
|
RS485_Set_Baud_Rate(9600);
|
|
break;
|
|
}
|
|
/* select async mode */
|
|
TXSTA2bits.SYNC = 0;
|
|
/* enable transmitter */
|
|
TXSTA2bits.TXEN = 1;
|
|
/* serial port enable */
|
|
RCSTA2bits.SPEN = 1;
|
|
/* since we are using RS485,
|
|
we need to explicitly say
|
|
transmit enable or not */
|
|
RS485_RX_DISABLE = 0;
|
|
RS485_TX_ENABLE = 0;
|
|
}
|
|
|
|
/****************************************************************************
|
|
* DESCRIPTION: Disables the RS485 hardware
|
|
* RETURN: none
|
|
* ALGORITHM: none
|
|
* NOTES: none
|
|
*****************************************************************************/
|
|
void RS485_Disable_Port(void)
|
|
{
|
|
RCSTA2 &= 0x4F; /* Disable the receiver */
|
|
TXSTA2bits.TXEN = 0; /* and transmitter */
|
|
PIE3 &= 0xCF; /* Disable both interrupts */
|
|
}
|
|
|
|
void RS485_Reinit(void)
|
|
{
|
|
RS485_Set_Baud_Rate(38400);
|
|
}
|
|
|
|
/****************************************************************************
|
|
* DESCRIPTION: Initializes the data and the port
|
|
* RETURN: none
|
|
* ALGORITHM: none
|
|
* NOTES: none
|
|
*****************************************************************************/
|
|
void RS485_Initialize(void)
|
|
{
|
|
/* Init the Rs485 buffers */
|
|
RS485_Comstat.RxHead = 0;
|
|
RS485_Comstat.RxTail = 0;
|
|
RS485_Comstat.Rx_Bytes = 0;
|
|
RS485_Comstat.Rx_Bufferoverrun = FALSE;
|
|
RS485_Comstat.TxHead = 0;
|
|
RS485_Comstat.TxTail = 0;
|
|
RS485_Comstat.Tx_Bytes = 0;
|
|
|
|
/* FIXME: read the data from storage */
|
|
/* I2C_Read_Block(
|
|
EEPROM_DEVICE_ADDRESS,
|
|
(char *)&RS485_Baud_Rate,
|
|
sizeof(RS485_Baud_Rate),
|
|
EEPROM_MSTP_BAUD_RATE_ADDR); */
|
|
|
|
RS485_Initialize_Port();
|
|
}
|