rebase upstream

.github/workflows/test.yaml

@@ -0,0 +1,62 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  native-os-build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-go@v1
+        with:
+          go-version: "1.13"
+      - name: Build native
+        run: GOARCH=amd64 go build -v ./...
+        shell: bash
+      - name: Install socat
+        if: matrix.os == 'ubuntu-latest'
+        run: sudo apt-get install socat
+        shell: bash
+      - name: Run unit tests
+        run: go test -v -race ./...
+        shell: bash
+      - name: Cross-build for 386
+        if: matrix.os != 'macOS-latest'
+        run: GOARCH=386 go build -v ./...
+        shell: bash
+      - name: Cross-build for arm
+        if: matrix.os != 'macOS-latest'
+        run: GOARCH=arm go build -v ./...
+        shell: bash
+
+  cross-os-build:
+    strategy:
+      matrix:
+        go-os-pairs:
+          - "freebsd amd64"
+          - "openbsd amd64"
+          - "openbsd 386"
+          - "openbsd arm"
+          - "linux ppc64le"
+
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-go@v1
+        with:
+          go-version: "1.13"
+      - name: Cross-build
+        run: |
+          set ${{ matrix.go-os-pairs }}
+          GOOS=$1 GOARCH=$2 go build -v ./...
+        shell: bash

LICENSE

@@ -1,5 +1,5 @@
 
-Copyright (c) 2014-2016, Cristian Maglie.
+Copyright (c) 2014-2021, Cristian Maglie.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,35 +1,27 @@
-[![Build Status](https://travis-ci.org/bugst/go-serial.svg?branch=v1)](https://travis-ci.org/bugst/go-serial)
+[![Build Status](https://github.com/bugst/go-serial/workflows/test/badge.svg)](https://github.com/bugst/go-serial/actions?workflow=test)
 
-# go.bug.st/serial.v1
+# go.bug.st/serial
 
 A cross-platform serial library for go-lang.
 
 ## Documentation and examples
 
-See the godoc here: https://godoc.org/go.bug.st/serial.v1
+See the godoc here: https://godoc.org/go.bug.st/serial
 
-## Development
+## go.mod transition
 
-If you want to contribute to the development of this library, you must clone this git repository directly into your `src` folder under `src/go.bug.st/serial.v1` and checkout the branch `v1`.
+This library now support `go.mod` with the import `go.bug.st/serial`.
 
-```
-cd $GOPATH
-mkdir -p src/go.bug.st/
-git clone https://github.com/bugst/go-serial.git -b v1 src/go.bug.st/serial.v1
-go test go.bug.st/serial.v1
-```
+If you came from the pre-`go.mod` era please update your import paths from `go.bug.st/serial.v1` to `go.bug.st/serial` to receive new updates. Anyway, the latest `v1` release should still be avaiable using the old import.
 
-## What's new in v1
+## Credits
 
-There are some API improvements, in particular object naming is now more idiomatic, class names are less redundant (for example `serial.SerialPort` is now called `serial.Port`), some internal class fields, constants or enumerations are now private and some methods have been moved into the proper interface.
-
-If you come from the version v0 and want to see the full list of API changes, please check this pull request:
-
-https://github.com/bugst/go-serial/pull/5/files
+:sparkles: Thanks to all awesome [contributors]! :sparkles:
 
 ## License
 
-The software is release under a BSD 3-clause license
+The software is release under a [BSD 3-clause license]
 
-https://github.com/bugst/go-serial/blob/v1/LICENSE
+[contributors]: https://github.com/bugst/go-serial/graphs/contributors
+[BSD 3-clause license]: https://github.com/bugst/go-serial/blob/master/LICENSE
 

doc.go

@@ -1,16 +1,16 @@
 //
-// Copyright 2014-2017 Cristian Maglie. All rights reserved.
+// Copyright 2014-2021 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
 
 /*
 Package serial is a cross-platform serial library for the go language.
 
-The canonical import for this library is go.bug.st/serial.v1 so the import line
+The canonical import for this library is go.bug.st/serial so the import line
 is the following:
 
-	import "go.bug.st/serial.v1"
+	import "go.bug.st/serial"
 
 It is possible to get the list of available serial ports with the
 GetPortsList function:
@@ -84,7 +84,7 @@ cable or a microcontroller development board) is possible to retrieve
 the USB metadata, like VID/PID or USB Serial Number, with the
 GetDetailedPortsList function in the enumerator package:
 
-	import "go.bug.st/serial.v1/enumerator"
+	import "go.bug.st/serial/enumerator"
 
 	ports, err := enumerator.GetDetailedPortsList()
 	if err != nil {
@@ -110,4 +110,4 @@ Unfortunately the USB enumeration package for darwin (MacOSX) requires cgo
 to access the IOKit framework. This means that if you need USB enumeration
 on darwin you're forced to use cgo.
 */
-package serial // import "go.bug.st/serial.v1"
+package serial

enumerator/doc.go

@@ -1,21 +1,15 @@
 //
-// Copyright 2014-2017 Cristian Maglie. All rights reserved.
+// Copyright 2014-2021 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
 
 /*
 Package enumerator is a golang cross-platform library for USB serial port discovery.
 
-WARNING: this library is still beta-testing code! please consider the library
-and the API as *unstable*. Beware that, even if at this point it's unlike to
-happen, the API may be subject to change until this notice is removed from
-the documentation.
-
 This library has been tested on Linux, Windows and Mac and uses specific OS
 services to enumerate USB PID/VID, in particular on MacOSX the use of cgo is
 required in order to access the IOKit Framework. This means that the library
-cannot be easily cross compiled for GOOS=darwing targets.
-
+cannot be easily cross compiled for darwin/* targets.
 */
-package enumerator // import "go.bug.st/serial.v1/enumerator"
+package enumerator

enumerator/enumerator.go

@@ -1,12 +1,12 @@
 //
-// Copyright 2014-2017 Cristian Maglie. All rights reserved.
+// Copyright 2014-2021 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
 
-package enumerator // import "go.bug.st/serial.v1/enumerator"
+package enumerator
 
-//go:generate go run ../extras/mksyscall_windows.go -output syscall_windows.go usb_windows.go
+//go:generate go run golang.org/x/sys/windows/mkwinsyscall -output syscall_windows.go usb_windows.go
 
 // PortDetails contains detailed information about USB serial port.
 // Use GetDetailedPortsList function to retrieve it.
@@ -18,7 +18,10 @@ type PortDetails struct {
 	SerialNumber string
 
 	// Manufacturer string
-	// Product      string
+
+	// Product is an OS-dependent string that describes the serial port, it may
+	// be not always available and it may be different across OS.
+	Product string
 }
 
 // GetDetailedPortsList retrieve ports details like USB VID/PID.

enumerator/example_getdetailedportlist_test.go

@@ -1,14 +1,17 @@
 //
-// Copyright 2014-2017 Cristian Maglie. All rights reserved.
+// Copyright 2014-2021 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
 
 package enumerator_test
 
-import "fmt"
-import "log"
-import "go.bug.st/serial.v1/enumerator"
+import (
+	"fmt"
+	"log"
+
+	"go.bug.st/serial/enumerator"
+)
 
 func ExampleGetDetailedPortsList() {
 	ports, err := enumerator.GetDetailedPortsList()