323 lines
9.7 KiB
C
323 lines
9.7 KiB
C
/*
|
|
Cross-platform serial / RS232 library
|
|
Version 0.21, 11/10/2015
|
|
-> WIN32 implementation
|
|
-> rs232-win.c
|
|
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2013-2015 Frédéric Meslin, Florent Touchard
|
|
Email: fredericmeslin@hotmail.com
|
|
Website: www.fredslab.net
|
|
Twitter: @marzacdev
|
|
|
|
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.
|
|
*/
|
|
|
|
#ifdef _WIN32
|
|
|
|
#include "rs232.h"
|
|
|
|
#include <stdio.h>
|
|
#include <string.h>
|
|
|
|
/*****************************************************************************/
|
|
typedef int bool;
|
|
#define true -1
|
|
#define false 0
|
|
|
|
typedef struct {
|
|
int port;
|
|
void * handle;
|
|
} COMDevice;
|
|
|
|
/*****************************************************************************/
|
|
#define COM_MAXDEVICES 64
|
|
static COMDevice comDevices[COM_MAXDEVICES];
|
|
static int noDevices = 0;
|
|
|
|
#define COM_MINDEVNAME 16384
|
|
const char * comPtn = "COM???";
|
|
|
|
/*****************************************************************************/
|
|
const char * findPattern(const char * string, const char * pattern, int * value);
|
|
const char * portInternalName(int index);
|
|
|
|
/*****************************************************************************/
|
|
typedef struct _COMMTIMEOUTS {
|
|
uint32_t ReadIntervalTimeout;
|
|
uint32_t ReadTotalTimeoutMultiplier;
|
|
uint32_t ReadTotalTimeoutConstant;
|
|
uint32_t WriteTotalTimeoutMultiplier;
|
|
uint32_t WriteTotalTimeoutConstant;
|
|
} COMMTIMEOUTS;
|
|
|
|
typedef struct _DCB {
|
|
uint32_t DCBlength;
|
|
uint32_t BaudRate;
|
|
uint32_t fBinary :1;
|
|
uint32_t fParity :1;
|
|
uint32_t fOutxCtsFlow :1;
|
|
uint32_t fOutxDsrFlow :1;
|
|
uint32_t fDtrControl :2;
|
|
uint32_t fDsrSensitivity :1;
|
|
uint32_t fTXContinueOnXoff :1;
|
|
uint32_t fOutX :1;
|
|
uint32_t fInX :1;
|
|
uint32_t fErrorChar :1;
|
|
uint32_t fNull :1;
|
|
uint32_t fRtsControl :2;
|
|
uint32_t fAbortOnError :1;
|
|
uint32_t fDummy2 :17;
|
|
uint16_t wReserved;
|
|
uint16_t XonLim;
|
|
uint16_t XoffLim;
|
|
uint8_t ByteSize;
|
|
uint8_t Parity;
|
|
uint8_t StopBits;
|
|
int8_t XonChar;
|
|
int8_t XoffChar;
|
|
int8_t ErrorChar;
|
|
int8_t EofChar;
|
|
int8_t EvtChar;
|
|
uint16_t wReserved1;
|
|
} DCB;
|
|
|
|
/*****************************************************************************/
|
|
/** Windows system constants */
|
|
#define ERROR_INSUFFICIENT_BUFFER 122
|
|
#define INVALID_HANDLE_VALUE ((void *) -1)
|
|
#define GENERIC_READ 0x80000000
|
|
#define GENERIC_WRITE 0x40000000
|
|
#define OPEN_EXISTING 3
|
|
#define MAX_DWORD 0xFFFFFFFF
|
|
|
|
/*****************************************************************************/
|
|
/** Windows system functions */
|
|
void * __stdcall CreateFileA(const char * lpFileName, uint32_t dwDesiredAccess, uint32_t dwShareMode, void * lpSecurityAttributes, uint32_t dwCreationDisposition, uint32_t dwFlagsAndAttributes, void * hTemplateFile);
|
|
bool __stdcall WriteFile(void * hFile, const void * lpBuffer, uint32_t nNumberOfBytesToWrite, uint32_t * lpNumberOfBytesWritten, void * lpOverlapped);
|
|
bool __stdcall ReadFile(void * hFile, void * lpBuffer, uint32_t nNumberOfBytesToRead, uint32_t * lpNumberOfBytesRead, void * lpOverlapped);
|
|
bool __stdcall CloseHandle(void * hFile);
|
|
|
|
uint32_t __stdcall GetLastError(void);
|
|
void __stdcall SetLastError(uint32_t dwErrCode);
|
|
|
|
uint32_t __stdcall QueryDosDeviceA(const char * lpDeviceName, char * lpTargetPath, uint32_t ucchMax);
|
|
|
|
bool __stdcall GetCommState(void * hFile, DCB * lpDCB);
|
|
bool __stdcall GetCommTimeouts(void * hFile, COMMTIMEOUTS * lpCommTimeouts);
|
|
bool __stdcall SetCommState(void * hFile, DCB * lpDCB);
|
|
bool __stdcall SetCommTimeouts(void * hFile, COMMTIMEOUTS * lpCommTimeouts);
|
|
bool __stdcall SetupComm(void * hFile, uint32_t dwInQueue, uint32_t dwOutQueue);
|
|
|
|
/*****************************************************************************/
|
|
int comEnumerate()
|
|
{
|
|
// Get devices information text
|
|
size_t size = COM_MINDEVNAME;
|
|
char * list = (char *) malloc(size);
|
|
SetLastError(0);
|
|
QueryDosDeviceA(NULL, list, (uint32_t)size);
|
|
while (GetLastError() == ERROR_INSUFFICIENT_BUFFER) {
|
|
size *= 2;
|
|
char * nlist = realloc(list, size);
|
|
if (!nlist) {
|
|
free(list);
|
|
return 0;
|
|
}
|
|
list = nlist;
|
|
SetLastError(0);
|
|
QueryDosDeviceA(NULL, list, (uint32_t)size);
|
|
}
|
|
// Gather all COM ports
|
|
int port;
|
|
const char * nlist = findPattern(list, comPtn, &port);
|
|
noDevices = 0;
|
|
while(port > 0 && noDevices < COM_MAXDEVICES) {
|
|
COMDevice * com = &comDevices[noDevices ++];
|
|
com->port = port;
|
|
com->handle = 0;
|
|
nlist = findPattern(nlist, comPtn, &port);
|
|
}
|
|
free(list);
|
|
return noDevices;
|
|
}
|
|
|
|
void comTerminate()
|
|
{
|
|
comCloseAll();
|
|
}
|
|
|
|
int comGetNoPorts()
|
|
{
|
|
return noDevices;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
const char * comGetPortName(int index)
|
|
{
|
|
#define COM_MAXNAME 32
|
|
static char name[COM_MAXNAME];
|
|
if (index < 0 || index >= noDevices)
|
|
return 0;
|
|
sprintf(name, "COM%i", comDevices[index].port);
|
|
return name;
|
|
}
|
|
|
|
int comFindPort(const char * name)
|
|
{
|
|
for (int i = 0; i < noDevices; i++)
|
|
if (strcmp(name, comGetPortName(i)) == 0)
|
|
return i;
|
|
return -1;
|
|
}
|
|
|
|
const char * comGetInternalName(int index)
|
|
{
|
|
#define COM_MAXNAME 32
|
|
static char name[COM_MAXNAME];
|
|
if (index < 0 || index >= noDevices)
|
|
return 0;
|
|
sprintf(name, "//./COM%i", comDevices[index].port);
|
|
return name;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
int comOpen(int index, int baudrate)
|
|
{
|
|
DCB config;
|
|
COMMTIMEOUTS timeouts;
|
|
if (index < 0 || index >= noDevices)
|
|
return 0;
|
|
// Close if already open
|
|
COMDevice * com = &comDevices[index];
|
|
if (com->handle) comClose(index);
|
|
// Open COM port
|
|
void * handle = CreateFileA(comGetInternalName(index), GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL);
|
|
if (handle == INVALID_HANDLE_VALUE)
|
|
return 0;
|
|
com->handle = handle;
|
|
// Prepare read / write timeouts
|
|
SetupComm(handle, 64, 64);
|
|
timeouts.ReadIntervalTimeout = MAX_DWORD;
|
|
timeouts.ReadTotalTimeoutConstant = 0;
|
|
timeouts.WriteTotalTimeoutConstant = 0;
|
|
timeouts.ReadTotalTimeoutMultiplier = 0;
|
|
timeouts.WriteTotalTimeoutMultiplier = 0;
|
|
SetCommTimeouts(handle, &timeouts);
|
|
// Prepare serial communication format
|
|
GetCommState(handle, &config);
|
|
config.BaudRate = baudrate;
|
|
config.fBinary = (uint32_t)true;
|
|
config.fParity = 0;
|
|
config.fErrorChar = 0;
|
|
config.fNull = 0;
|
|
config.fAbortOnError = 0;
|
|
config.ByteSize = 8;
|
|
config.Parity = 0;
|
|
config.StopBits = 0;
|
|
config.EvtChar = '\n';
|
|
// Set the port state
|
|
if (SetCommState(handle, &config) == 0) {
|
|
CloseHandle(handle);
|
|
return 0;
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
void comClose(int index)
|
|
{
|
|
if (index < 0 || index >= noDevices)
|
|
return;
|
|
COMDevice * com = &comDevices[index];
|
|
if (!com->handle)
|
|
return;
|
|
CloseHandle(com->handle);
|
|
com->handle = 0;
|
|
}
|
|
|
|
void comCloseAll()
|
|
{
|
|
for (int i = 0; i < noDevices; i++)
|
|
comClose(i);
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
int comWrite(int index, const char * buffer, size_t len)
|
|
{
|
|
if (index < 0 || index >= noDevices)
|
|
return 0;
|
|
COMDevice * com = &comDevices[index];
|
|
uint32_t bytes = 0;
|
|
WriteFile(com->handle, buffer, (uint32_t)len, &bytes, NULL);
|
|
return bytes;
|
|
}
|
|
|
|
int comRead(int index, char * buffer, size_t len)
|
|
{
|
|
if (index < 0 || index >= noDevices)
|
|
return 0;
|
|
COMDevice * com = &comDevices[index];
|
|
uint32_t bytes = 0;
|
|
ReadFile(com->handle, buffer, (uint32_t)len, &bytes, NULL);
|
|
return bytes;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
const char * findPattern(const char * string, const char * pattern, int * value)
|
|
{
|
|
char c, n = 0;
|
|
const char * sp = string;
|
|
const char * pp = pattern;
|
|
// Check for the string pattern
|
|
while (1) {
|
|
c = *sp ++;
|
|
if (c == '\0') {
|
|
if (*pp == '?') break;
|
|
if (*sp == '\0') break;
|
|
n = 0;
|
|
pp = pattern;
|
|
}else{
|
|
if (*pp == '?') {
|
|
// Expect a digit
|
|
if (c >= '0' && c <= '9') {
|
|
n = n * 10 + (c - '0');
|
|
if (*pp ++ == '\0') break;
|
|
}else{
|
|
n = 0;
|
|
pp = comPtn;
|
|
}
|
|
}else{
|
|
// Expect a character
|
|
if (c == *pp) {
|
|
if (*pp ++ == '\0') break;
|
|
}else{
|
|
n = 0;
|
|
pp = comPtn;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// Return the value
|
|
* value = n;
|
|
return sp;
|
|
}
|
|
|
|
#endif // _WIN32
|