lwip/contrib/ports/win32/sio.c

305 lines
9.2 KiB
C
Raw Normal View History

/*
* Copyright (c) 2001-2003 Swedish Institute of Computer Science.
2018-10-22 18:33:35 +00:00
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
2018-10-22 18:33:35 +00:00
* derived from this software without specific prior written permission.
*
2018-10-22 18:33:35 +00:00
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
* SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
* This file is part of the lwIP TCP/IP stack.
2018-10-22 18:33:35 +00:00
*
*/
#include <lwip/opt.h>
#include <lwip/sys.h>
#include <lwip/sio.h>
#include <stdio.h>
#include <stdarg.h>
#ifdef _MSC_VER
#pragma warning (push, 3)
#endif
#include <windows.h>
#ifdef _MSC_VER
#pragma warning (pop)
#endif
#include "lwipcfg.h"
/** When 1, use COM ports, when 0, use named pipes (for simulation). */
#ifndef SIO_USE_COMPORT
#define SIO_USE_COMPORT 1
#endif
/** If SIO_USE_COMPORT==1, use COMx, if 0, use a pipe (default) */
#if SIO_USE_COMPORT
#define SIO_DEVICENAME "\\\\.\\COM"
#else
#define SIO_DEVICENAME "\\\\.\\pipe\\lwip"
#endif
#if SIO_USE_COMPORT
#ifndef SIO_COMPORT_SPEED
#define SIO_COMPORT_SPEED 115200
#endif
#ifndef SIO_COMPORT_BYTESIZE
#define SIO_COMPORT_BYTESIZE 8
#endif
#ifndef SIO_COMPORT_STOPBITS
#define SIO_COMPORT_STOPBITS 0 /* ONESTOPBIT */
#endif
#ifndef SIO_COMPORT_PARITY
#define SIO_COMPORT_PARITY 0 /* NOPARITY */
#endif
#endif /* SIO_USE_COMPORT */
static int sio_abort = 0;
/* \\.\pipe\lwip0 */
/* pppd /dev/ttyS0 logfile mylog debug nocrtscts local noauth noccp ms-dns 212.27.54.252 192.168.0.4:192.168.0.5
*/
/**
* SIO_DEBUG: Enable debugging for SIO.
*/
#ifndef SIO_DEBUG
#define SIO_DEBUG LWIP_DBG_OFF
#endif
#if SIO_USE_COMPORT
/** When using a real COM port, set up the
* serial line settings (baudrate etc.)
*/
static BOOL
sio_setup(HANDLE fd)
{
COMMTIMEOUTS cto;
DCB dcb;
/* set up baudrate and other communication settings */
memset(&dcb, 0, sizeof(dcb));
/* Obtain the DCB structure for the device */
if (!GetCommState(fd, &dcb)) {
return FALSE;
}
/* Set the new data */
dcb.BaudRate = SIO_COMPORT_SPEED;
dcb.ByteSize = SIO_COMPORT_BYTESIZE;
dcb.StopBits = 0; /* ONESTOPBIT */
dcb.Parity = 0; /* NOPARITY */
dcb.fParity = 0; /* parity is not used */
/* do not use flow control */
/*dcb.fOutxDsrFlow = dcb.fDtrControl = 0;
dcb.fOutxCtsFlow = dcb.fRtsControl = 0;
dcb.fErrorChar = dcb.fNull = 0;
dcb.fInX = dcb.fOutX = 0;
dcb.XonChar = dcb.XoffChar = 0;
dcb.XonLim = dcb.XoffLim = 100;*/
/* Set the new DCB structure */
if (!SetCommState(fd, &dcb)) {
return FALSE;
}
memset(&cto, 0, sizeof(cto));
if(!GetCommTimeouts(fd, &cto))
{
return FALSE;
}
/* change read timeout, leave write timeout as it is */
cto.ReadIntervalTimeout = 1;
cto.ReadTotalTimeoutMultiplier = 0;
cto.ReadTotalTimeoutConstant = 1; /* 1 ms */
if(!SetCommTimeouts(fd, &cto)) {
return FALSE;
}
return TRUE;
}
#endif /* SIO_USE_COMPORT */
/**
* Opens a serial device for communication.
2018-10-22 18:33:35 +00:00
*
* @param devnum device number
* @return handle to serial device if successful, NULL otherwise
*/
sio_fd_t sio_open(u8_t devnum)
{
HANDLE fileHandle = INVALID_HANDLE_VALUE;
CHAR fileName[256];
LWIP_DEBUGF(SIO_DEBUG, ("sio_open(%lu)\n", (DWORD)devnum));
#if SIO_USE_COMPORT
snprintf(fileName, 255, SIO_DEVICENAME"%lu", (DWORD)(devnum));
#else /* SIO_USE_COMPORT */
snprintf(fileName, 255, SIO_DEVICENAME"%lu", (DWORD)(devnum & ~1));
if ((devnum & 1) == 0) {
fileHandle = CreateNamedPipeA(fileName, PIPE_ACCESS_DUPLEX, PIPE_TYPE_BYTE | PIPE_NOWAIT,
PIPE_UNLIMITED_INSTANCES, 102400, 102400, 100, NULL);
} else
#endif /* SIO_USE_COMPORT */
{
fileHandle = CreateFileA(fileName, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
}
if (fileHandle != INVALID_HANDLE_VALUE) {
sio_abort = 0;
#if !SIO_USE_COMPORT
if (devnum & 1) {
DWORD mode = PIPE_NOWAIT;
if (!SetNamedPipeHandleState(fileHandle, &mode, NULL, NULL)) {
LWIP_DEBUGF(SIO_DEBUG, ("sio_open(%lu): SetNamedPipeHandleState failed. GetLastError() returns %d\n",
(DWORD)devnum, GetLastError()));
}
} else
#endif /* !SIO_USE_COMPORT */
{
FlushFileBuffers(fileHandle);
}
#if SIO_USE_COMPORT
if(!sio_setup(fileHandle)) {
CloseHandle(fileHandle);
LWIP_DEBUGF(SIO_DEBUG, ("sio_open(%lu): sio_setup failed. GetLastError() returns %lu\n",
(DWORD)devnum, GetLastError()));
return NULL;
}
#endif /* SIO_USE_COMPORT */
LWIP_DEBUGF(SIO_DEBUG, ("sio_open: file \"%s\" successfully opened.\n", fileName));
printf("sio_open: file \"%s\" (%d) successfully opened: 0x%08x\n", fileName, devnum, LWIP_PTR_NUMERIC_CAST(unsigned int, fileHandle));
return (sio_fd_t)(fileHandle);
}
LWIP_DEBUGF(SIO_DEBUG, ("sio_open(%lu) failed. GetLastError() returns %lu\n",
(DWORD)devnum, GetLastError()));
printf("sio_open(%lu) failed. GetLastError() returns %lu\n",
(DWORD)devnum, GetLastError());
return NULL;
}
/**
* Sends a single character to the serial device.
2018-10-22 18:33:35 +00:00
*
* @param c character to send
* @param fd serial device handle
2018-10-22 18:33:35 +00:00
*
* @note This function will block until the character can be sent.
*/
void sio_send(u8_t c, sio_fd_t fd)
{
DWORD dwNbBytesWritten = 0;
LWIP_DEBUGF(SIO_DEBUG, ("sio_send(%lu)\n", (DWORD)c));
while ((!WriteFile((HANDLE)(fd), &c, 1, &dwNbBytesWritten, NULL)) || (dwNbBytesWritten < 1)) {
}
}
/**
* Receives a single character from the serial device.
2018-10-22 18:33:35 +00:00
*
* @param fd serial device handle
2018-10-22 18:33:35 +00:00
*
* @note This function will block until a character is received.
*/
u8_t sio_recv(sio_fd_t fd)
{
DWORD dwNbBytesReadden = 0;
u8_t byte = 0;
LWIP_DEBUGF(SIO_DEBUG, ("sio_recv()\n"));
while ((sio_abort == 0) && ((!ReadFile((HANDLE)(fd), &byte, 1, &dwNbBytesReadden, NULL)) || (dwNbBytesReadden < 1)));
LWIP_DEBUGF(SIO_DEBUG, ("sio_recv()=%lu\n", (DWORD)byte));
return byte;
}
/**
* Reads from the serial device.
2018-10-22 18:33:35 +00:00
*
* @param fd serial device handle
* @param data pointer to data buffer for receiving
* @param len maximum length (in bytes) of data to receive
* @return number of bytes actually received - may be 0 if aborted by sio_read_abort
2018-10-22 18:33:35 +00:00
*
* @note This function will block until data can be received. The blocking
* can be cancelled by calling sio_read_abort().
*/
u32_t sio_read(sio_fd_t fd, u8_t* data, u32_t len)
{
BOOL ret;
DWORD dwNbBytesReadden = 0;
LWIP_DEBUGF(SIO_DEBUG, ("sio_read()...\n"));
ret = ReadFile((HANDLE)(fd), data, len, &dwNbBytesReadden, NULL);
LWIP_DEBUGF(SIO_DEBUG, ("sio_read()=%lu bytes -> %d\n", dwNbBytesReadden, ret));
LWIP_UNUSED_ARG(ret);
return dwNbBytesReadden;
}
/**
* Tries to read from the serial device. Same as sio_read but returns
* immediately if no data is available and never blocks.
2018-10-22 18:33:35 +00:00
*
* @param fd serial device handle
* @param data pointer to data buffer for receiving
* @param len maximum length (in bytes) of data to receive
* @return number of bytes actually received
*/
u32_t sio_tryread(sio_fd_t fd, u8_t* data, u32_t len)
{
/* @todo: implement non-blocking read */
BOOL ret;
DWORD dwNbBytesReadden = 0;
LWIP_DEBUGF(SIO_DEBUG, ("sio_read()...\n"));
ret = ReadFile((HANDLE)(fd), data, len, &dwNbBytesReadden, NULL);
LWIP_DEBUGF(SIO_DEBUG, ("sio_read()=%lu bytes -> %d\n", dwNbBytesReadden, ret));
LWIP_UNUSED_ARG(ret);
return dwNbBytesReadden;
}
/**
* Writes to the serial device.
2018-10-22 18:33:35 +00:00
*
* @param fd serial device handle
* @param data pointer to data to send
* @param len length (in bytes) of data to send
* @return number of bytes actually sent
2018-10-22 18:33:35 +00:00
*
* @note This function will block until all data can be sent.
*/
u32_t sio_write(sio_fd_t fd, const u8_t* data, u32_t len)
{
BOOL ret;
DWORD dwNbBytesWritten = 0;
LWIP_DEBUGF(SIO_DEBUG, ("sio_write()...\n"));
ret = WriteFile((HANDLE)(fd), data, len, &dwNbBytesWritten, NULL);
LWIP_DEBUGF(SIO_DEBUG, ("sio_write()=%lu bytes -> %d\n", dwNbBytesWritten, ret));
LWIP_UNUSED_ARG(ret);
return dwNbBytesWritten;
}
/**
* Aborts a blocking sio_read() call.
* @todo: This currently ignores fd and aborts all reads
2018-10-22 18:33:35 +00:00
*
* @param fd serial device handle
*/
void sio_read_abort(sio_fd_t fd)
{
LWIP_UNUSED_ARG(fd);
LWIP_DEBUGF(SIO_DEBUG, ("sio_read_abort() !!!!!...\n"));
sio_abort = 1;
return;
}