diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a09c56d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.idea diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..d4c0ca5 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "editor.formatOnSave": true, + "editor.codeActionsOnSave": { + "source.fixAll": true + } +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..92b7000 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2021 Septs + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..1a926c1 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# CH912x + +> The program provides CH912x series chip configuration tools + +## Supported + +| Chip Name | Status | +| --------- | ------ | +| CH9120 | TESTED | +| CH9121 | TESTED | +| CH9126 | TESTED | + +## Command line + +- [cmd/ch912x-api](cmd/ch912x-api) + + Provide a simple web-oriented API. + +## References + +- [docs](docs) + +## LICENSE + +[MIT LICENSE](LICENSE), but not include [docs](docs) folder diff --git a/ch9120.go b/ch9120.go new file mode 100644 index 0000000..0e65f40 --- /dev/null +++ b/ch9120.go @@ -0,0 +1,188 @@ +package ch912x + +import ( + "bufio" + "bytes" + "encoding/binary" + "encoding/json" + "io" + "net" + "strconv" +) + +type CH9120 struct { + Kind Kind `json:"-"` + Version string `json:"version,omitempty"` + ModuleName string `json:"module_name,omitempty"` + ModuleMAC net.HardwareAddr `json:"module_mac,omitempty"` + ClientMAC net.HardwareAddr `json:"client_mac,omitempty"` + ModuleOptions *ModuleOptions `json:"module_options,omitempty"` + UART1 *UARTService `json:"uart_1,omitempty"` +} + +func (p *CH9120) setClientMAC(addr net.HardwareAddr) { + p.ClientMAC = addr +} + +func (p *CH9120) identity() (Kind, net.HardwareAddr) { + return p.Kind, p.ModuleMAC +} + +func (p *CH9120) moduleIP() net.IP { + if p.ModuleOptions == nil { + return nil + } + return p.ModuleOptions.IP +} + +func (p *CH9120) MarshalJSON() ([]byte, error) { + type Module CH9120 + module := new(struct { + Product Product `json:"product"` + *Module + }) + module.Product = ProductCH9120 + module.Module = (*Module)(p) + return json.Marshal(module) +} + +func (p *CH9120) UnmarshalJSON(data []byte) (err error) { + type Module CH9120 + module := new(struct { + Product Product `json:"product"` + *Module + }) + module.Module = (*Module)(p) + err = json.Unmarshal(data, module) + if err == nil && module.Product != ProductCH9120 { + err = ErrCH9120InvalidJSON + } + return +} + +func (p *CH9120) ReadFrom(r io.Reader) (n int64, err error) { + header := new(ch9121Header) + err = binary.Read(r, binary.LittleEndian, header) + if err != nil { + return + } + p.Kind = header.Kind + if p.Kind == KindDiscoveryResponse { + discovery := new(ch9121Discovery) + err = binary.Read(r, binary.LittleEndian, discovery) + p.ModuleMAC = discovery.ModuleMAC[:] + p.ClientMAC = discovery.ClientMAC[:] + p.ModuleOptions = &ModuleOptions{IP: discovery.IP[:]} + buf := bufio.NewReader(r) + moduleName, _ := buf.ReadBytes(0) + p.ModuleName = trimNull(moduleName) + version, _ := buf.ReadByte() + p.Version = strconv.Itoa(int(version)) + return + } + c := new(ch9120Configuration) + err = binary.Read(r, binary.LittleEndian, c) + if err != nil { + return + } + p.ModuleName = trimNull(c.ModuleName[:]) + p.ModuleMAC = c.ModuleMAC[:] + p.ClientMAC = c.ClientMAC[:] + p.ModuleOptions = &ModuleOptions{ + MAC: c.ModuleOptions.ModuleMAC[:], + IP: c.ModuleOptions.IP[:], + Mask: c.ModuleOptions.Mask[:], + Gateway: c.ModuleOptions.Gateway[:], + UseDHCP: fromVariantBool(c.ModuleOptions.DHCP), + SerialNegotiate: fromVariantBool(c.ModuleOptions.SerialNegotiate), + } + p.UART1 = &UARTService{ + Mode: UARTMode(c.UART.Mode), + ClientIP: c.UART.ClientIP[:], + ClientPort: c.UART.ClientPort, + LocalPort: c.UART.TargetPort, + PacketSize: c.UART.RXSize, + PacketTimeout: c.UART.RXTimeout, + RandomClientPort: fromVariantBool(c.UART.RandomClientPort), + CloseOnLost: fromVariantBool(c.UART.CloseOnLost), + ClearOnReconnect: fromVariantBool(c.UART.ClearOnTimeout), + Baud: c.UART.Baud, + DataBits: c.UART.DataBits, + StopBit: c.UART.StopBit, + Parity: fromCH9121Parity(c.UART.Parity), + UseDomain: fromVariantBool(c.UART.UseDomain), + ClientDomain: trimNull(c.UART.ClientDomain[:]), + } + return +} + +func (p *CH9120) WriteTo(w io.Writer) (n int64, err error) { + var buf bytes.Buffer + h := &ch9121Header{Kind: p.Kind} + copy(h.Header[:], magicCH9120) + _ = binary.Write(&buf, binary.LittleEndian, h) + r := new(ch9120Configuration) + copy(r.ModuleMAC[:], p.ModuleMAC) + copy(r.ClientMAC[:], p.ClientMAC) + copy(r.ModuleName[:], p.ModuleName) + if opt := p.ModuleOptions; opt != nil { + copy(r.ModuleOptions.ModuleMAC[:], opt.MAC) + copy(r.ModuleOptions.IP[:], opt.IP) + copy(r.ModuleOptions.Mask[:], opt.Mask) + copy(r.ModuleOptions.Gateway[:], opt.Gateway) + r.ModuleOptions.DHCP = toVariantBool(opt.UseDHCP) + r.ModuleOptions.SerialNegotiate = toVariantBool(opt.SerialNegotiate) + } + if p.UART1 != nil { + r.UART = ch9120UART{ + Mode: byte(p.UART1.Mode), + RandomClientPort: toVariantBool(p.UART1.RandomClientPort), + ClientPort: p.UART1.ClientPort, + TargetPort: p.UART1.LocalPort, + Baud: p.UART1.Baud, + DataBits: p.UART1.DataBits, + StopBit: p.UART1.StopBit, + Parity: toCH9121Parity(p.UART1.Parity), + CloseOnLost: toVariantBool(p.UART1.CloseOnLost), + RXSize: p.UART1.PacketSize, + RXTimeout: p.UART1.PacketTimeout, + ClearOnTimeout: toVariantBool(p.UART1.ClearOnReconnect), + } + copy(r.UART.ClientIP[:], p.UART1.ClientIP) + r.UART.UseDomain = toVariantBool(p.UART1.UseDomain) + copy(r.UART.ClientDomain[:], p.UART1.ClientDomain) + } + _ = binary.Write(&buf, binary.LittleEndian, r) + _, _ = buf.Write(make([]byte, 285-buf.Len())) + return buf.WriteTo(w) +} + +type ch9120Configuration struct { + ModuleMAC [6]byte + ClientMAC [6]byte + _ [6]byte + ModuleName [21]byte + ModuleOptions ch9121ModuleOptions + _ [75]byte + UART ch9120UART +} + +type ch9120UART struct { + Mode byte + RandomClientPort byte + ClientPort uint16 + ClientIP [4]byte + TargetPort uint16 + Baud uint32 + DataBits byte + StopBit byte + Parity byte // None, Evan, Odd, Mark, Space + CloseOnLost byte + RXSize uint16 + _ [2]byte + RXTimeout uint16 + _ [3]byte + ClearOnTimeout byte + UseDomain byte + ClientDomain [20]byte +} diff --git a/ch9121.go b/ch9121.go new file mode 100644 index 0000000..fa8c82a --- /dev/null +++ b/ch9121.go @@ -0,0 +1,238 @@ +package ch912x + +import ( + "bufio" + "bytes" + "encoding/binary" + "encoding/json" + "io" + "net" + "strconv" +) + +type CH9121 struct { + Kind Kind `json:"-"` + Version string `json:"version,omitempty"` + ModuleName string `json:"module_name,omitempty"` + ModuleMAC net.HardwareAddr `json:"module_mac,omitempty"` + ClientMAC net.HardwareAddr `json:"client_mac,omitempty"` + ModuleOptions *ModuleOptions `json:"module_options,omitempty"` + UART1 *UARTService `json:"uart_1,omitempty"` + UART2 *UARTService `json:"uart_2,omitempty"` +} + +func (p *CH9121) setClientMAC(addr net.HardwareAddr) { + p.ClientMAC = addr +} + +func (p *CH9121) identity() (Kind, net.HardwareAddr) { + return p.Kind, p.ModuleMAC +} + +func (p *CH9121) moduleIP() net.IP { + if p.ModuleOptions == nil { + return nil + } + return p.ModuleOptions.IP +} + +func (p *CH9121) MarshalJSON() ([]byte, error) { + type Module CH9121 + module := new(struct { + Product Product `json:"product"` + *Module + }) + module.Product = ProductCH9121 + module.Module = (*Module)(p) + return json.Marshal(module) +} + +func (p *CH9121) UnmarshalJSON(data []byte) (err error) { + type Module CH9121 + module := new(struct { + Product Product `json:"product"` + *Module + }) + module.Module = (*Module)(p) + err = json.Unmarshal(data, module) + if err == nil && module.Product != ProductCH9121 { + err = ErrCH9121InvalidJSON + } + return +} + +func (p *CH9121) ReadFrom(r io.Reader) (n int64, err error) { + header := new(ch9121Header) + err = binary.Read(r, binary.LittleEndian, header) + if err != nil { + return + } + p.Kind = header.Kind + if p.Kind == KindDiscoveryResponse { + discovery := new(ch9121Discovery) + err = binary.Read(r, binary.LittleEndian, discovery) + p.ModuleMAC = discovery.ModuleMAC[:] + p.ClientMAC = discovery.ClientMAC[:] + p.ModuleOptions = &ModuleOptions{IP: discovery.IP[:]} + buf := bufio.NewReader(r) + moduleName, _ := buf.ReadBytes(0) + p.ModuleName = trimNull(moduleName) + version, _ := buf.ReadByte() + p.Version = strconv.Itoa(int(version)) + return + } + c := new(ch9121Configuration) + err = binary.Read(r, binary.LittleEndian, c) + if err != nil { + return + } + p.ModuleName = trimNull(c.ModuleName[:]) + p.ModuleMAC = c.ModuleMAC[:] + p.ClientMAC = c.ClientMAC[:] + p.ModuleOptions = &ModuleOptions{ + MAC: c.ModuleOptions.ModuleMAC[:], + IP: c.ModuleOptions.IP[:], + Mask: c.ModuleOptions.Mask[:], + Gateway: c.ModuleOptions.Gateway[:], + UseDHCP: fromVariantBool(c.ModuleOptions.DHCP), + SerialNegotiate: fromVariantBool(c.ModuleOptions.SerialNegotiate), + EnabledMinorUART: fromVariantBool(c.EnabledUART2), + } + setUART := func(uart ch9121UART) *UARTService { + return &UARTService{ + Mode: UARTMode(uart.Mode), + ClientIP: uart.ClientIP[:], + ClientPort: uart.ClientPort, + LocalPort: uart.TargetPort, + PacketSize: uart.RXSize, + PacketTimeout: uart.RXTimeout, + RandomClientPort: fromVariantBool(uart.RandomClientPort), + CloseOnLost: fromVariantBool(uart.CloseOnLost), + ClearOnReconnect: fromVariantBool(uart.ClearOnTimeout), + Baud: uart.BaudRate, + DataBits: uart.DataBits, + StopBit: uart.StopBit, + Parity: fromCH9121Parity(uart.Parity), + UseDomain: fromVariantBool(uart.UseDomain), + ClientDomain: trimNull(uart.ClientDomain[:]), + } + } + p.UART1 = setUART(c.UART1) + p.UART2 = setUART(c.UART2) + return +} + +func (p *CH9121) WriteTo(w io.Writer) (n int64, err error) { + var buf bytes.Buffer + h := &ch9121Header{Kind: p.Kind} + copy(h.Header[:], magicCH9121) + _ = binary.Write(&buf, binary.LittleEndian, h) + r := new(ch9121Configuration) + copy(r.ModuleMAC[:], p.ModuleMAC) + copy(r.ClientMAC[:], p.ClientMAC) + copy(r.ModuleName[:], p.ModuleName) + if opt := p.ModuleOptions; opt != nil { + copy(r.ModuleOptions.ModuleMAC[:], opt.MAC) + copy(r.ModuleOptions.IP[:], opt.IP) + copy(r.ModuleOptions.Mask[:], opt.Mask) + copy(r.ModuleOptions.Gateway[:], opt.Gateway) + r.ModuleOptions.DHCP = toVariantBool(opt.UseDHCP) + r.ModuleOptions.SerialNegotiate = toVariantBool(opt.SerialNegotiate) + r.EnabledUART2 = toVariantBool(opt.EnabledMinorUART) + } + setUART := func(uart *UARTService) ch9121UART { + if uart == nil { + return ch9121UART{} + } + options := ch9121UART{ + Mode: byte(uart.Mode), + RandomClientPort: toVariantBool(uart.RandomClientPort), + ClientPort: uart.ClientPort, + TargetPort: uart.LocalPort, + BaudRate: uart.Baud, + DataBits: uart.DataBits, + StopBit: uart.StopBit, + Parity: toCH9121Parity(uart.Parity), + CloseOnLost: toVariantBool(uart.CloseOnLost), + RXSize: uart.PacketSize, + RXTimeout: uart.PacketTimeout, + ClearOnTimeout: toVariantBool(uart.ClearOnReconnect), + UseDomain: toVariantBool(uart.UseDomain), + } + copy(options.ClientIP[:], uart.ClientIP) + copy(options.ClientDomain[:], uart.ClientDomain) + return options + } + r.UART1 = setUART(p.UART1) + r.UART2 = setUART(p.UART2) + _ = binary.Write(&buf, binary.LittleEndian, r) + _, _ = buf.Write(make([]byte, 285-buf.Len())) + return buf.WriteTo(w) +} + +func fromCH9121Parity(p byte) UARTParity { + if p == 4 { + return ParityNone + } + return UARTParity(p + 1) +} + +func toCH9121Parity(p UARTParity) byte { + if p == ParityNone { + return 0 + } + return byte(p - 1) +} + +type ch9121Header struct { + Header [16]byte + Kind Kind +} + +type ch9121Discovery struct { + ModuleMAC [6]byte + ClientMAC [6]byte + _ byte + IP [4]byte +} + +type ch9121Configuration struct { + ModuleMAC [6]byte + ClientMAC [6]byte + _ [6]byte + ModuleName [21]byte + ModuleOptions ch9121ModuleOptions + _ [9]byte + EnabledUART2 byte + UART2, UART1 ch9121UART +} + +type ch9121ModuleOptions struct { + ModuleMAC [6]byte + IP [4]byte + Gateway [4]byte + Mask [4]byte + DHCP byte + _ [20]byte + SerialNegotiate byte +} + +type ch9121UART struct { + Mode byte // TCP Server, TCP Client, UDP Server, UDP Client + RandomClientPort byte + ClientPort uint16 + ClientIP [4]byte + TargetPort uint16 + BaudRate uint32 + DataBits byte + StopBit byte + Parity byte // None, Evan, Odd, Mark, Space + CloseOnLost byte + RXSize uint16 + RXTimeout uint16 + _ [5]byte + ClearOnTimeout byte + UseDomain byte + ClientDomain [21]byte + _ [15]byte +} diff --git a/ch9126.go b/ch9126.go new file mode 100644 index 0000000..6698e83 --- /dev/null +++ b/ch9126.go @@ -0,0 +1,191 @@ +package ch912x + +import ( + "bytes" + "encoding/binary" + "encoding/json" + "io" + "net" +) + +type CH9126 struct { + Kind Kind `json:"-"` + Version string `json:"version,omitempty"` + ModuleName string `json:"module_name,omitempty"` + ModuleMAC net.HardwareAddr `json:"module_mac,omitempty"` + ClientMAC net.HardwareAddr `json:"client_mac,omitempty"` + ModuleOptions *ModuleOptions `json:"module_options,omitempty"` + UART1 *UARTService `json:"uart_1,omitempty"` + NTP *NTPService `json:"ntp,omitempty"` +} + +func (p *CH9126) setClientMAC(addr net.HardwareAddr) { + p.ClientMAC = addr +} + +func (p *CH9126) identity() (Kind, net.HardwareAddr) { + return p.Kind, p.ModuleMAC +} + +func (p *CH9126) moduleIP() net.IP { + if p.ModuleOptions == nil { + return nil + } + return p.ModuleOptions.IP +} + +func (p *CH9126) MarshalJSON() ([]byte, error) { + type Module CH9126 + module := new(struct { + Product Product `json:"product"` + *Module + }) + module.Product = ProductCH9126 + module.Module = (*Module)(p) + return json.Marshal(module) +} + +func (p *CH9126) UnmarshalJSON(data []byte) (err error) { + type Module CH9126 + module := new(struct { + Product Product `json:"product"` + *Module + }) + module.Module = (*Module)(p) + err = json.Unmarshal(data, module) + if err == nil && module.Product != ProductCH9126 { + err = ErrCH9126InvalidJSON + } + return +} + +func (p *CH9126) ReadFrom(r io.Reader) (n int64, err error) { + c := new(ch9126Configuration) + err = binary.Read(r, binary.LittleEndian, c) + if err != nil { + return + } + p.Version = string(c.Version[:]) + p.Kind = c.Kind + p.ModuleName = trimNull(c.ModuleName[:]) + p.ModuleMAC = c.ModuleMAC[:] + p.ClientMAC = c.ClientMAC[:] + p.ModuleOptions = &ModuleOptions{ + MAC: c.ModuleOptions.Address[:], + IP: c.ModuleOptions.IP[:], + Gateway: c.ModuleOptions.Gateway[:], + EnabledMinorUART: fromVariantBool(c.UARTService.Enabled), + } + p.NTP = &NTPService{ + Enabled: fromVariantBool(c.NTPService.Enabled), + Mode: NTPMode(c.NTPService.Mode - 5), + ClientIP: c.NTPService.ClientIP[:], + Polling: c.NTPService.Polling, + PulseOutput: fromVariantBool(c.PulseOutput), + KeepAlive: fromVariantBool(c.KeepAlive.Enabled), + } + p.UART1 = &UARTService{ + Mode: UARTMode(c.UARTService.Mode - 1), + ClientIP: c.UARTService.ClientIP[:], + ClientPort: c.UARTService.ClientPort, + PacketSize: c.UARTOptions.PacketSize, + PacketTimeout: c.UARTOptions.PacketTimeout, + LocalPort: c.UARTService.LocalPort, + Baud: c.UARTOptions.Baud, + DataBits: c.UARTOptions.DataBits, + StopBit: c.UARTOptions.StopBit, + Parity: UARTParity(c.UARTOptions.Parity), + } + return +} + +func (p *CH9126) WriteTo(w io.Writer) (n int64, err error) { + var buf bytes.Buffer + r := &ch9126Configuration{Kind: p.Kind} + copy(r.Header[:], magicCH9126) + copy(r.ModuleName[:], p.ModuleName) + copy(r.ModuleMAC[:], p.ModuleMAC) + copy(r.ClientMAC[:], p.ClientMAC) + if opt := p.ModuleOptions; opt != nil { + copy(r.ModuleOptions.Address[:], opt.MAC) + copy(r.ModuleOptions.IP[:], opt.IP) + copy(r.ModuleOptions.Mask[:], opt.Mask) + copy(r.ModuleOptions.Gateway[:], opt.Gateway) + r.UARTService.Enabled = toVariantBool(opt.EnabledMinorUART) + } + if ntp := p.NTP; ntp != nil { + copy(r.NTPService.ClientIP[:], ntp.ClientIP) + r.NTPService.Enabled = toVariantBool(ntp.Enabled) + r.NTPService.Mode = byte(ntp.Mode + 0x05) + r.NTPService.Polling = ntp.Polling + r.PulseOutput = toVariantBool(ntp.PulseOutput) + r.KeepAlive.Enabled = toVariantBool(ntp.KeepAlive) + } + if uart := p.UART1; uart != nil { + r.UARTOptions.Baud = uart.Baud + r.UARTOptions.DataBits = uart.DataBits + r.UARTOptions.StopBit = uart.StopBit + r.UARTOptions.Parity = byte(uart.Parity) + r.UARTOptions.PacketSize = uart.PacketSize + r.UARTOptions.PacketTimeout = uart.PacketTimeout + r.UARTService.Mode = byte(uart.Mode) + r.UARTService.ClientPort = uart.ClientPort + r.UARTService.LocalPort = uart.LocalPort + copy(r.UARTService.ClientIP[:], uart.ClientIP) + } + _ = binary.Write(&buf, binary.LittleEndian, r) + _, _ = buf.Write(make([]byte, 367-buf.Len())) + return buf.WriteTo(w) +} + +type ch9126Configuration struct { + Header [0x40]byte // CH9126_MODULE_V1.03 + Version [4]byte // V110 + ModuleName [0x40]byte + _ [8]byte + Kind Kind + ModuleMAC [6]byte + ClientMAC [6]byte + UARTOptions struct { + Baud uint32 + DataBits byte + StopBit byte + Parity byte // Evan, Odd, Mark, Space, None + PacketSize uint16 + PacketTimeout uint16 + _ byte + } + ModuleOptions struct { + Address [6]byte + IP [4]byte + Mask [4]byte + Gateway [4]byte + _ [13]byte + } + PulseOutput byte + _ [3]byte + KeepAlive struct { + Enabled byte + Time uint32 + Interval uint32 + Probes uint32 + } + NTPService struct { + Enabled byte + Mode byte // 5: NTP Server, 6: NTP Client + _ [2]byte + ClientIP [4]byte + Polling uint16 + _ [3]byte + } + UARTService struct { + Enabled byte + Mode byte // _, TCP Server, TCP Client, UDP Server, UDP Client + _ byte + _ byte + ClientIP [4]byte + ClientPort uint16 + _ byte + LocalPort uint16 + } +} diff --git a/cmd/ch912x-api/README.md b/cmd/ch912x-api/README.md new file mode 100644 index 0000000..033667c --- /dev/null +++ b/cmd/ch912x-api/README.md @@ -0,0 +1,11 @@ +# CH912x APIs + +## Endpoints + +```plain +/events # event streaming +/api/discovery # discovery all devices +/api/ch9120/:mac-address # ch9120 +/api/ch9121/:mac-address # ch9121 +/api/ch9126/:mac-address # ch9126 +``` diff --git a/cmd/ch912x-api/api.go b/cmd/ch912x-api/api.go new file mode 100644 index 0000000..fa00aac --- /dev/null +++ b/cmd/ch912x-api/api.go @@ -0,0 +1,109 @@ +package main + +import ( + "context" + "encoding/base64" + "net" + "net/http" + + "github.com/CursedHardware/ch912x" + "github.com/labstack/echo/v4" + "github.com/labstack/echo/v4/middleware" + "golang.org/x/sync/errgroup" +) + +type CustomizedContext struct { + echo.Context + Product ch912x.Product + Address net.HardwareAddr +} + +func makeAPIService() http.Handler { + mux := echo.New() + mux.Use(middleware.Secure()) + mux.GET("/discovery", onDiscovery) // discovery all type + mux.GET("/:product/:address", onPullModule, onBind) // pull + mux.POST("/:product/:address", onPushModule, onBind) // push + mux.DELETE("/:product/:address", onResetModule, onBind) // reset + return mux +} + +func onDiscovery(ctx echo.Context) (err error) { + ctx.Response().WriteHeader(http.StatusNoContent) + var group errgroup.Group + group.Go(func() error { return plane.SendDiscovery(ch912x.ProductCH9120) }) + group.Go(func() error { return plane.SendDiscovery(ch912x.ProductCH9121) }) + group.Go(func() error { return plane.SendDiscovery(ch912x.ProductCH9126) }) + return group.Wait() +} + +func onPullModule(ctx echo.Context) (err error) { + product := ctx.(*CustomizedContext).Product + address := ctx.(*CustomizedContext).Address + module, err := plane.Pull(context.Background(), product, address) + if err == nil { + return ctx.JSON(http.StatusOK, module) + } + return +} + +func onResetModule(ctx echo.Context) (err error) { + product := ctx.(*CustomizedContext).Product + address := ctx.(*CustomizedContext).Address + module, err := plane.Reset(context.Background(), product, address) + if err == nil { + return ctx.JSON(http.StatusOK, module) + } + return +} + +func onPushModule(ctx echo.Context) (err error) { + address := ctx.(*CustomizedContext).Address + var module ch912x.Module + switch ctx.(*CustomizedContext).Product { + case ch912x.ProductCH9120: + module = &ch912x.CH9120{Kind: ch912x.KindPushRequest, ModuleMAC: address} + case ch912x.ProductCH9121: + module = &ch912x.CH9121{Kind: ch912x.KindPushRequest, ModuleMAC: address} + case ch912x.ProductCH9126: + module = &ch912x.CH9126{Kind: ch912x.KindPushRequest, ModuleMAC: address} + } + if err = ctx.Bind(module); err != nil { + return + } + module, err = plane.Push(context.Background(), module) + if err == nil { + return ctx.JSON(http.StatusOK, module) + } + return +} + +func onBind(next echo.HandlerFunc) echo.HandlerFunc { + return func(ctx echo.Context) (err error) { + address, err := base64.StdEncoding.DecodeString(ctx.Param("address")) + if err != nil { + err = echo.NewHTTPError(http.StatusBadRequest, err.Error()) + return + } + product := ch912x.Product(ctx.Param("product")) + switch product { + case ch912x.ProductCH9120: + case ch912x.ProductCH9121: + case ch912x.ProductCH9126: + default: + err = echo.NewHTTPError(http.StatusBadRequest, ch912x.ErrUnknownModuleType) + return + } + err = next(&CustomizedContext{ + Context: ctx, + Product: product, + Address: address[0:6], + }) + if err != nil { + if _, ok := err.(*echo.HTTPError); !ok { + err = echo.NewHTTPError(http.StatusInternalServerError, err.Error()) + } + } + return + } +} diff --git a/cmd/ch912x-api/main.go b/cmd/ch912x-api/main.go new file mode 100644 index 0000000..8094bb2 --- /dev/null +++ b/cmd/ch912x-api/main.go @@ -0,0 +1,42 @@ +package main + +import ( + "encoding/json" + "flag" + "log" + "net/http" + + "github.com/CursedHardware/ch912x" + "gopkg.in/antage/eventsource.v1" +) + +var plane *ch912x.ControlPlane + +func init() { + var err error + var nic string + flag.StringVar(&nic, "nic", "", "") + flag.Parse() + plane, err = ch912x.ListenCH912XByName(nic) + if err != nil { + log.Fatal(err) + } +} + +func main() { + events := eventsource.New(nil, nil) + defer events.Close() + mux := http.NewServeMux() + mux.Handle("/events", events) + mux.Handle("/api/", http.StripPrefix("/api", makeAPIService())) + go sendDiscoveryEvents(events) + log.Println("listen :8080") + _ = http.ListenAndServe(":8080", mux) +} + +func sendDiscoveryEvents(events eventsource.EventSource) { + for module := range plane.Discovery() { + data, _ := json.Marshal(module) + events.SendEventMessage(string(data), "discovery", "") + } +} diff --git a/constants.go b/constants.go new file mode 100644 index 0000000..0c5f297 --- /dev/null +++ b/constants.go @@ -0,0 +1,38 @@ +package ch912x + +type ( + Product string + Kind byte + UARTMode byte + UARTParity byte + NTPMode byte +) + +const ( + magicCH9120 = "CH9120_CFG_FLAG" + magicCH9121 = "CH9121_CFG_FLAG" + magicCH9126 = "CH9126_MODULE_V1.03" + magicModule = "NET_MODULE_COMM" + ProductCH9120 Product = "CH9120" + ProductCH9121 Product = "CH9121" + ProductCH9126 Product = "CH9126" + KindPushRequest Kind = 0x01 + KindPullRequest Kind = 0x02 + KindResetRequest Kind = 0x03 + KindDiscoveryRequest Kind = 0x04 + KindPushResponse Kind = 0x81 + KindPullResponse Kind = 0x82 + KindResetResponse Kind = 0x83 + KindDiscoveryResponse Kind = 0x84 + TCPServer UARTMode = 0x00 + TCPClient UARTMode = 0x01 + UDPServer UARTMode = 0x02 + UDPClient UARTMode = 0x03 + ParityNone UARTParity = 0x00 + ParityEven UARTParity = 0x01 + ParityOdd UARTParity = 0x02 + ParityMark UARTParity = 0x03 + ParitySpace UARTParity = 0x04 + NTPServer NTPMode = 0x00 + NTPClient NTPMode = 0x01 +) diff --git a/control_plane.go b/control_plane.go new file mode 100644 index 0000000..6e86bef --- /dev/null +++ b/control_plane.go @@ -0,0 +1,241 @@ +package ch912x + +import ( + "bytes" + "context" + "net" + "time" + + "github.com/mdlayher/arp" +) + +const ( + listenPort = 60000 + controlPort = 50000 +) + +type ControlPlane struct { + udpClient net.PacketConn + arpClient *arp.Client + clientMAC net.HardwareAddr + pairs map[string]func(Module) + arpTable map[string]func() + discovery chan Module + Timeout time.Duration + SendTimeout time.Duration +} + +func ListenCH912XByName(name string) (*ControlPlane, error) { + ifi, err := net.InterfaceByName(name) + if err != nil { + return nil, err + } + return ListenCH912X(ifi) +} + +func ListenCH912X(ifi *net.Interface) (plane *ControlPlane, err error) { + if ifi == nil { + err = ErrInvalidNetworkInterface + return + } + addr := &net.UDPAddr{Port: listenPort} + plane = &ControlPlane{ + discovery: make(chan Module), + pairs: make(map[string]func(Module)), + arpTable: make(map[string]func()), + clientMAC: ifi.HardwareAddr, + Timeout: 15 * time.Second, + SendTimeout: time.Second, + } + plane.udpClient, err = net.ListenUDP("udp", addr) + if err == nil { + err = bindInterfaceToUDPConn(plane.udpClient.(*net.UDPConn), ifi) + } + if err == nil { + plane.arpClient, err = arp.Dial(ifi) + } + if err == nil { + go plane.watchUDP() + go plane.watchARP() + } + return +} + +func (p *ControlPlane) watchUDP() { + var data [0x200]byte + for { + n, _, err := p.udpClient.ReadFrom(data[:]) + if err != nil { + break + } + go p.handleResponse(data[:n]) + } + close(p.discovery) +} + +func (p *ControlPlane) watchARP() { + for { + packet, _, err := p.arpClient.Read() + if err != nil { + break + } + go p.handleARP(packet) + } + return +} + +func (p *ControlPlane) Discovery() <-chan Module { + return p.discovery +} + +func (p *ControlPlane) SendDiscovery(product Product) (err error) { + err = ErrUnknownModuleType + switch product { + case ProductCH9120: + err = p.push(&CH9120{Kind: KindDiscoveryRequest}) + case ProductCH9121: + err = p.push(&CH9121{Kind: KindDiscoveryRequest}) + case ProductCH9126: + err = p.push(&CH9126{Kind: KindDiscoveryRequest}) + } + return +} + +func (p *ControlPlane) Pull(ctx context.Context, product Product, address net.HardwareAddr) (module Module, err error) { + err = ErrUnknownModuleType + switch product { + case ProductCH9120: + module, err = p.send(ctx, &CH9120{Kind: KindPullRequest, ModuleMAC: address}) + case ProductCH9121: + module, err = p.send(ctx, &CH9121{Kind: KindPullRequest, ModuleMAC: address}) + case ProductCH9126: + module, err = p.send(ctx, &CH9126{Kind: KindPullRequest, ModuleMAC: address}) + } + return +} + +func (p *ControlPlane) Push(ctx context.Context, module Module) (parsed Module, err error) { + ctx, cancel := context.WithTimeout(ctx, p.Timeout) + defer cancel() + kind, address := module.identity() + if kind != KindPushRequest { + err = ErrModuleKindWrong + return + } + parsed, err = p.send(ctx, module) + if err != nil { + return + } + select { + case <-ctx.Done(): + return + case <-p.waitFirstARP(address): + return + } +} + +func (p *ControlPlane) Reset(ctx context.Context, product Product, address net.HardwareAddr) (module Module, err error) { + ctx, cancel := context.WithTimeout(ctx, p.Timeout) + defer cancel() + err = ErrUnknownModuleType + switch product { + case ProductCH9120: + module, err = p.send(ctx, &CH9120{Kind: KindResetRequest, ModuleMAC: address}) + case ProductCH9121: + module, err = p.send(ctx, &CH9121{Kind: KindResetRequest, ModuleMAC: address}) + case ProductCH9126: + module, err = p.send(ctx, &CH9126{Kind: KindResetRequest, ModuleMAC: address}) + } + if err != nil { + return + } + select { + case <-ctx.Done(): + return + case <-p.waitFirstARP(address): + return + } +} + +func (p *ControlPlane) send(ctx context.Context, module Module) (parsed Module, err error) { + ctx, cancel := context.WithTimeout(ctx, p.SendTimeout) + defer cancel() + module.setClientMAC(p.clientMAC) + _, addr := module.identity() + if addr == nil { + err = ErrModuleMustMAC + return + } else if _, ok := p.pairs[addr.String()]; ok { + err = ErrTaskRunning + return + } + returns := make(chan Module, 1) + p.pairs[addr.String()] = func(parsed Module) { returns <- parsed } + defer delete(p.pairs, addr.String()) + if err = p.push(module); err != nil { + return + } + select { + case <-ctx.Done(): + err = ctx.Err() + case parsed = <-returns: + err, _ = parsed.(error) + } + return +} + +func (p *ControlPlane) push(module Module) (err error) { + ip := module.moduleIP() + if ip == nil { + ip = net.IPv4bcast + } + var buf bytes.Buffer + _, _ = module.WriteTo(&buf) + _, err = p.udpClient.WriteTo(buf.Bytes(), &net.UDPAddr{IP: ip, Port: controlPort}) + return +} + +func (p *ControlPlane) waitFirstARP(address net.HardwareAddr) chan struct{} { + returns := make(chan struct{}, 1) + p.arpTable[address.String()] = func() { returns <- struct{}{} } + defer delete(p.arpTable, address.String()) + return returns +} + +func (p *ControlPlane) handleResponse(data []byte) { + var module Module + switch { + case bytes.HasPrefix(data, []byte(magicCH9120)): + module = new(CH9120) + case bytes.HasPrefix(data, []byte(magicCH9121)): + module = new(CH9121) + case bytes.HasPrefix(data, []byte(magicCH9126)): + module = new(CH9126) + case bytes.HasPrefix(data, []byte(magicModule)): + return + default: + panic(ErrUnknownModuleType) + } + _, _ = module.ReadFrom(bytes.NewReader(data)) + kind, addr := module.identity() + if kind == KindDiscoveryResponse { + p.discovery <- module + } else if fn, ok := p.pairs[addr.String()]; ok { + fn(module) + } + return +} + +func (p *ControlPlane) handleARP(packet *arp.Packet) { + if fn, ok := p.arpTable[packet.SenderHardwareAddr.String()]; ok { + fn() + } +} + +func (p *ControlPlane) Close() (err error) { + err = p.udpClient.Close() + if err == nil { + err = p.arpClient.Close() + } + return +} diff --git a/docs/CH9120/CH9120DS1.pdf b/docs/CH9120/CH9120DS1.pdf new file mode 100644 index 0000000..df50144 Binary files /dev/null and b/docs/CH9120/CH9120DS1.pdf differ diff --git a/docs/CH9120/Configuration_Tools.exe b/docs/CH9120/Configuration_Tools.exe new file mode 100644 index 0000000..dfc77a5 Binary files /dev/null and b/docs/CH9120/Configuration_Tools.exe differ diff --git a/docs/CH9120/Module/CH9120SCH.pdf b/docs/CH9120/Module/CH9120SCH.pdf new file mode 100644 index 0000000..2b54d76 Binary files /dev/null and b/docs/CH9120/Module/CH9120SCH.pdf differ diff --git a/docs/CH9120/Module/Product-Manual.pdf b/docs/CH9120/Module/Product-Manual.pdf new file mode 100644 index 0000000..fd5622a Binary files /dev/null and b/docs/CH9120/Module/Product-Manual.pdf differ diff --git a/docs/CH9120/Module/User-Manual.pdf b/docs/CH9120/Module/User-Manual.pdf new file mode 100644 index 0000000..bd42486 Binary files /dev/null and b/docs/CH9120/Module/User-Manual.pdf differ diff --git a/docs/CH9120/README.md b/docs/CH9120/README.md new file mode 100644 index 0000000..3ffe030 --- /dev/null +++ b/docs/CH9120/README.md @@ -0,0 +1,5 @@ +# CH9120 + +Product page: + +Datasheet: [CH9120DS1.pdf](CH9120DS1.pdf) diff --git a/docs/CH9120/Serial_Control_Command.pdf b/docs/CH9120/Serial_Control_Command.pdf new file mode 100644 index 0000000..a9626d8 Binary files /dev/null and b/docs/CH9120/Serial_Control_Command.pdf differ diff --git a/docs/CH9121/CH9121DS1.pdf b/docs/CH9121/CH9121DS1.pdf new file mode 100644 index 0000000..2e9cf40 Binary files /dev/null and b/docs/CH9121/CH9121DS1.pdf differ diff --git a/docs/CH9121/CH9121SCH.pdf b/docs/CH9121/CH9121SCH.pdf new file mode 100644 index 0000000..2e45cdf Binary files /dev/null and b/docs/CH9121/CH9121SCH.pdf differ diff --git a/docs/CH9121/NET-SER-DT/NET-SER-DT.ddb b/docs/CH9121/NET-SER-DT/NET-SER-DT.ddb new file mode 100644 index 0000000..8c08399 Binary files /dev/null and b/docs/CH9121/NET-SER-DT/NET-SER-DT.ddb differ diff --git a/docs/CH9121/NET-SER-DT/Product-Manual.pdf b/docs/CH9121/NET-SER-DT/Product-Manual.pdf new file mode 100644 index 0000000..7590ad7 Binary files /dev/null and b/docs/CH9121/NET-SER-DT/Product-Manual.pdf differ diff --git a/docs/CH9121/NET-SER-DT/User-Manual.pdf b/docs/CH9121/NET-SER-DT/User-Manual.pdf new file mode 100644 index 0000000..2818f3c Binary files /dev/null and b/docs/CH9121/NET-SER-DT/User-Manual.pdf differ diff --git a/docs/CH9121/NetModuleConfig.exe b/docs/CH9121/NetModuleConfig.exe new file mode 100644 index 0000000..9f6c8b2 Binary files /dev/null and b/docs/CH9121/NetModuleConfig.exe differ diff --git a/docs/CH9121/README.md b/docs/CH9121/README.md new file mode 100644 index 0000000..5f336cc --- /dev/null +++ b/docs/CH9121/README.md @@ -0,0 +1,9 @@ +# CH9121 + +Product page: + +Datasheet: [CH9121DS1.pdf](CH9120DS1.pdf) + +## References + +- diff --git a/docs/CH9121/Serial_Configuration_Protocol.pdf b/docs/CH9121/Serial_Configuration_Protocol.pdf new file mode 100644 index 0000000..781f6f3 Binary files /dev/null and b/docs/CH9121/Serial_Configuration_Protocol.pdf differ diff --git a/docs/CH9121/Serial_Control_Command.pdf b/docs/CH9121/Serial_Control_Command.pdf new file mode 100644 index 0000000..348cc90 Binary files /dev/null and b/docs/CH9121/Serial_Control_Command.pdf differ diff --git a/docs/CH9126/CH9126DS.pdf b/docs/CH9126/CH9126DS.pdf new file mode 100644 index 0000000..729633f Binary files /dev/null and b/docs/CH9126/CH9126DS.pdf differ diff --git a/docs/CH9126/Module/CH9126SCH.pdf b/docs/CH9126/Module/CH9126SCH.pdf new file mode 100644 index 0000000..3f2231c Binary files /dev/null and b/docs/CH9126/Module/CH9126SCH.pdf differ diff --git a/docs/CH9126/Module/User-Manual.pdf b/docs/CH9126/Module/User-Manual.pdf new file mode 100644 index 0000000..baf837c Binary files /dev/null and b/docs/CH9126/Module/User-Manual.pdf differ diff --git a/docs/CH9126/README.md b/docs/CH9126/README.md new file mode 100644 index 0000000..096fbeb --- /dev/null +++ b/docs/CH9126/README.md @@ -0,0 +1,3 @@ +# CH9126 + +Product page: diff --git a/docs/CH9126/SNTPModuleCFG.exe b/docs/CH9126/SNTPModuleCFG.exe new file mode 100644 index 0000000..1e2a0c7 Binary files /dev/null and b/docs/CH9126/SNTPModuleCFG.exe differ diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..c21331c --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +# Documentation + +## Wireshark filter + +```plain +udp port 50000 and udp port 60000 +``` + +## Chip series + +| Chip Name | UARTs | Ethernet | +| ---------------- | ----- | ----------- | +| [CH9120](CH9120) | 1 | 10 Mbps | +| [CH9121](CH9121) | 2 | 10/100 Mbps | +| [CH9126](CH9126) | 1 | 10/100 Mbps | diff --git a/errors.go b/errors.go new file mode 100644 index 0000000..774d5e7 --- /dev/null +++ b/errors.go @@ -0,0 +1,14 @@ +package ch912x + +import "errors" + +var ( + ErrInvalidNetworkInterface = errors.New("ch912x: invalid network interface") + ErrCH9120InvalidJSON = errors.New("ch912x: the JSON not is CH9120 configuration") + ErrCH9121InvalidJSON = errors.New("ch912x: the JSON not is CH9121 configuration") + ErrCH9126InvalidJSON = errors.New("ch912x: the JSON not is CH9126 configuration") + ErrModuleKindWrong = errors.New("ch912x: the module kind wrong") + ErrModuleMustMAC = errors.New("ch912x: the need to provide `ModuleMAC`") + ErrTaskRunning = errors.New("ch912x: the previous task was not completed") + ErrUnknownModuleType = errors.New("ch912x: unknown module type") +) diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..0f16731 --- /dev/null +++ b/go.mod @@ -0,0 +1,14 @@ +module github.com/CursedHardware/ch912x + +go 1.16 + +require ( + github.com/labstack/echo/v4 v4.2.0 + github.com/mdlayher/arp v0.0.0-20191213142603-f72070a231fc + github.com/mdlayher/ethernet v0.0.0-20190606142754-0394541c37b7 // indirect + github.com/mdlayher/raw v0.0.0-20210412142147-51b895745faf // indirect + golang.org/x/net v0.0.0-20210726213435-c6fcb2dbf985 // indirect + golang.org/x/sync v0.0.0-20210220032951-036812b2e83c + golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c // indirect + gopkg.in/antage/eventsource.v1 v1.0.0-20150318155416-803f4c5af225 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..198f549 --- /dev/null +++ b/go.sum @@ -0,0 +1,88 @@ +github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM= +github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= +github.com/google/go-cmp v0.2.0 h1:+dTQ8DZQJz0Mb/HjFlkptS1FeQ4cWSnN941F8aEG4SQ= +github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= +github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU= +github.com/labstack/echo/v4 v4.2.0 h1:jkCSsjXmBmapVXF6U4BrSz/cgofWM0CU3Q74wQvXkIc= +github.com/labstack/echo/v4 v4.2.0/go.mod h1:AA49e0DZ8kk5jTOOCKNuPR6oTnBS0dYiM4FW1e6jwpg= +github.com/labstack/gommon v0.3.0 h1:JEeO0bvc78PKdyHxloTKiF8BD5iGrH8T6MSeGvSgob0= +github.com/labstack/gommon v0.3.0/go.mod h1:MULnywXg0yavhxWKc+lOruYdAhDwPK9wf0OL7NoOu+k= +github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= +github.com/mattn/go-colorable v0.1.7 h1:bQGKb3vps/j0E9GfJQ03JyhRuxsvdAanXlT9BTw3mdw= +github.com/mattn/go-colorable v0.1.7/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= +github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= +github.com/mattn/go-isatty v0.0.9/go.mod h1:YNRxwqDuOph6SZLI9vUUz6OYw3QyUt7WiY2yME+cCiQ= +github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY= +github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/mdlayher/arp v0.0.0-20191213142603-f72070a231fc h1:m7rJJJeXrYCFpsxXYapkDW53wJCDmf9bsIXUg0HoeQY= +github.com/mdlayher/arp v0.0.0-20191213142603-f72070a231fc/go.mod h1:eOj1DDj3NAZ6yv+WafaKzY37MFZ58TdfIhQ+8nQbiis= +github.com/mdlayher/ethernet v0.0.0-20190313224307-5b5fc417d966 h1:O3p5UmisBhl3V6lgs4Vdfg8HpjzbWJPyOfGLdwVJSmI= +github.com/mdlayher/ethernet v0.0.0-20190313224307-5b5fc417d966/go.mod h1:5s5p/sMJ6sNsFl6uCh85lkFGV8kLuIYJCRJLavVJwvg= +github.com/mdlayher/ethernet v0.0.0-20190606142754-0394541c37b7 h1:lez6TS6aAau+8wXUP3G9I3TGlmPFEq2CTxBaRqY6AGE= +github.com/mdlayher/ethernet v0.0.0-20190606142754-0394541c37b7/go.mod h1:U6ZQobyTjI/tJyq2HG+i/dfSoFUt8/aZCM+GKtmFk/Y= +github.com/mdlayher/raw v0.0.0-20190313224157-43dbcdd7739d h1:rjAS0af7FIYCScTtEU5KjIldC6qVaEScUJhABHC+ccM= +github.com/mdlayher/raw v0.0.0-20190313224157-43dbcdd7739d/go.mod h1:r1fbeITl2xL/zLbVnNHFyOzQJTgr/3fpf1lJX/cjzR8= +github.com/mdlayher/raw v0.0.0-20190606142536-fef19f00fc18/go.mod h1:7EpbotpCmVZcu+KCX4g9WaRNuu11uyhiW7+Le1dKawg= +github.com/mdlayher/raw v0.0.0-20191009151244-50f2db8cc065 h1:aFkJ6lx4FPip+S+Uw4aTegFMct9shDvP+79PsSxpm3w= +github.com/mdlayher/raw v0.0.0-20191009151244-50f2db8cc065/go.mod h1:7EpbotpCmVZcu+KCX4g9WaRNuu11uyhiW7+Le1dKawg= +github.com/mdlayher/raw v0.0.0-20210412142147-51b895745faf h1:InctQoB89TIkmgIFQeIL4KXNvWc1iebQXdZggqPSwL8= +github.com/mdlayher/raw v0.0.0-20210412142147-51b895745faf/go.mod h1:7EpbotpCmVZcu+KCX4g9WaRNuu11uyhiW7+Le1dKawg= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk= +github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= +github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= +github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= +github.com/valyala/fasttemplate v1.0.1/go.mod h1:UQGH1tvbgY+Nz5t2n7tXsz52dQxojPUpymEIMZ47gx8= +github.com/valyala/fasttemplate v1.2.1 h1:TVEnxayobAdVkhQfrfes2IzOB6o+z4roRkPF52WA1u4= +github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a h1:vclmkQCjlDX5OydZ9wv8rBCcS0QyQY66Mpf/7BZbInM= +golang.org/x/crypto v0.0.0-20200820211705-5c72a883971a/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= +golang.org/x/net v0.0.0-20190313220215-9f648a60d977/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190419010253-1f3472d942ba/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= +golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= +golang.org/x/net v0.0.0-20200822124328-c89045814202 h1:VvcQYSHwXgi7W+TpUR6A9g6Up98WAHf3f/ulnJ62IyA= +golang.org/x/net v0.0.0-20200822124328-c89045814202/go.mod h1:/O7V0waA8r7cgGh81Ro3o1hOxt32SMVPicZroKQ2sZA= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110 h1:qWPm9rbaAMKs8Bq/9LRpbMqxWRVUAQwMI9fVrssnTfw= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20210726213435-c6fcb2dbf985 h1:4CSI6oo7cOjJKajidEljs9h+uP0rRZBPPPhcCbj5mw8= +golang.org/x/net v0.0.0-20210726213435-c6fcb2dbf985/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ= +golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190312061237-fead79001313/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190418153312-f0ce4c0180be/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190606122018-79a91cf218c4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190813064441-fde4db37ae7a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200826173525-f9321e4c35a6 h1:DvY3Zkh7KabQE/kfzMvYvKirSiguP9Q/veMtkYyf0o8= +golang.org/x/sys v0.0.0-20200826173525-f9321e4c35a6/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210309074719-68d13333faf2 h1:46ULzRKLh1CwgRq2dC5SlBzEqqNCi8rreOZnNrbqcIY= +golang.org/x/sys v0.0.0-20210309074719-68d13333faf2/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c h1:F1jZWGFhYfh0Ci55sIpILtKKK8p3i2/krTr0H1rg74I= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3 h1:cokOdA+Jmi5PJGXLlLllQSgYigAEfHXJAERHVMaCc2k= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 h1:Hir2P/De0WpUhtrKGGjvSb2YxUgyZ7EFOSLIcSSpiwE= +golang.org/x/time v0.0.0-20201208040808-7e3f01d25324/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +gopkg.in/antage/eventsource.v1 v1.0.0-20150318155416-803f4c5af225 h1:xy+AV3uSExoRQc2qWXeZdbhFGwBFK/AmGlrBZEjbvuQ= +gopkg.in/antage/eventsource.v1 v1.0.0-20150318155416-803f4c5af225/go.mod h1:SiXNRpUllqhl+GIw2V/BtKI7BUlz+uxov9vBFtXHqh8= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= +gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/types.go b/types.go new file mode 100644 index 0000000..be07bdc --- /dev/null +++ b/types.go @@ -0,0 +1,51 @@ +package ch912x + +import ( + "io" + "net" +) + +type Module interface { + identity() (Kind, net.HardwareAddr) + moduleIP() net.IP + setClientMAC(net.HardwareAddr) + io.ReaderFrom + io.WriterTo +} + +type ModuleOptions struct { + MAC net.HardwareAddr `json:"mac,omitempty"` + IP net.IP `json:"ip,omitempty"` + Mask net.IP `json:"mask,omitempty"` + Gateway net.IP `json:"gateway,omitempty"` + UseDHCP bool `json:"use_dhcp,omitempty"` + SerialNegotiate bool `json:"serial_negotiate,omitempty"` + EnabledMinorUART bool `json:"enabled_minor_uart,omitempty"` +} + +type UARTService struct { + Mode UARTMode `json:"mode"` + ClientIP net.IP `json:"client_ip"` + ClientPort uint16 `json:"client_port"` + ClientDomain string `json:"client_domain"` + UseDomain bool `json:"use_domain"` + LocalPort uint16 `json:"local_port"` + PacketSize uint16 `json:"packet_size"` + PacketTimeout uint16 `json:"packet_timeout"` + RandomClientPort bool `json:"random_client_port,omitempty"` + CloseOnLost bool `json:"close_on_lost"` + ClearOnReconnect bool `json:"clear_on_reconnect"` + Baud uint32 `json:"baud"` + DataBits uint8 `json:"data_bits"` + StopBit uint8 `json:"stop_bit"` + Parity UARTParity `json:"parity"` +} + +type NTPService struct { + Enabled bool `json:"enabled"` + Mode NTPMode `json:"mode"` + ClientIP net.IP `json:"client_ip"` + Polling uint16 `json:"polling"` + PulseOutput bool `json:"pulse_output"` + KeepAlive bool `json:"keep_alive"` +} diff --git a/utils.go b/utils.go new file mode 100644 index 0000000..050f4d4 --- /dev/null +++ b/utils.go @@ -0,0 +1,33 @@ +package ch912x + +import ( + "net" + "strings" + "syscall" +) + +func trimNull(values []byte) string { + return strings.TrimRight(string(values), "\x00") +} + +func fromVariantBool(x byte) bool { + return x != 0 +} + +func toVariantBool(x bool) byte { + if x { + return 1 + } + return 0 +} + +func bindInterfaceToUDPConn(conn *net.UDPConn, ifi *net.Interface) (err error) { + raw, err := conn.SyscallConn() + if err != nil { + return + } + return raw.Control(func(fd uintptr) { + // see https://stackoverflow.com/a/57013928 + _ = syscall.SetsockoptInt(int(fd), syscall.SOL_SOCKET, syscall.IP_BOUND_IF, ifi.Index) + }) +}