discovery.go 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
  1. package modem
  2. import (
  3. "context"
  4. "fmt"
  5. "io/fs"
  6. "os"
  7. "path/filepath"
  8. "sort"
  9. "strconv"
  10. "strings"
  11. )
  12. const quectelVendorID = "2c7c"
  13. type SysFSDiscoverer struct {
  14. SysRoot string
  15. DevRoot string
  16. }
  17. func NewSysFSDiscoverer(sysRoot, devRoot string) *SysFSDiscoverer {
  18. return &SysFSDiscoverer{
  19. SysRoot: filepath.Clean(sysRoot),
  20. DevRoot: filepath.Clean(devRoot),
  21. }
  22. }
  23. type discoveredUSBDevice struct {
  24. candidate Candidate
  25. ports map[string]Port
  26. }
  27. func (d *SysFSDiscoverer) Discover(ctx context.Context) ([]Candidate, error) {
  28. if err := ctx.Err(); err != nil {
  29. return nil, err
  30. }
  31. usbRoot := filepath.Join(d.SysRoot, "bus", "usb", "devices")
  32. entries, err := os.ReadDir(usbRoot)
  33. if err != nil {
  34. if os.IsNotExist(err) {
  35. return nil, nil
  36. }
  37. return nil, fmt.Errorf("discover Quectel USB devices: %w", err)
  38. }
  39. aliases := readSerialAliases(filepath.Join(d.DevRoot, "serial", "by-id"))
  40. devices := make(map[string]*discoveredUSBDevice)
  41. for _, entry := range entries {
  42. if err := ctx.Err(); err != nil {
  43. return nil, err
  44. }
  45. interfaceNumber, ok := parseUSBInterfaceName(entry.Name())
  46. if !ok {
  47. continue
  48. }
  49. interfacePath := filepath.Join(usbRoot, entry.Name())
  50. resolvedInterface, err := filepath.EvalSymlinks(interfacePath)
  51. if err != nil {
  52. resolvedInterface = interfacePath
  53. }
  54. if value, err := readHexByte(filepath.Join(resolvedInterface, "bInterfaceNumber")); err == nil {
  55. interfaceNumber = value
  56. }
  57. deviceName := strings.SplitN(entry.Name(), ":", 2)[0]
  58. devicePath := filepath.Join(usbRoot, deviceName)
  59. resolvedDevice, err := filepath.EvalSymlinks(devicePath)
  60. if err != nil {
  61. resolvedDevice = devicePath
  62. }
  63. vendorID := strings.ToLower(readTrimmed(filepath.Join(resolvedDevice, "idVendor")))
  64. if vendorID != quectelVendorID {
  65. continue
  66. }
  67. state := devices[deviceName]
  68. if state == nil {
  69. productID := strings.ToLower(readTrimmed(filepath.Join(resolvedDevice, "idProduct")))
  70. serialNumber := readTrimmed(filepath.Join(resolvedDevice, "serial"))
  71. state = &discoveredUSBDevice{
  72. candidate: Candidate{
  73. ID: candidateID(productID, serialNumber, deviceName),
  74. VendorID: vendorID,
  75. ProductID: productID,
  76. Manufacturer: readTrimmed(filepath.Join(resolvedDevice, "manufacturer")),
  77. Product: readTrimmed(filepath.Join(resolvedDevice, "product")),
  78. SerialNumber: serialNumber,
  79. USBPath: devicePath,
  80. },
  81. ports: make(map[string]Port),
  82. }
  83. devices[deviceName] = state
  84. }
  85. ttyNames, qmiControls, networkInterfaces := scanUSBInterface(resolvedInterface)
  86. for _, name := range ttyNames {
  87. if !strings.HasPrefix(name, "ttyUSB") && !strings.HasPrefix(name, "ttyACM") {
  88. continue
  89. }
  90. path := filepath.Join(d.DevRoot, name)
  91. state.ports[name] = Port{
  92. Path: path,
  93. StablePath: aliases[name],
  94. Name: name,
  95. InterfaceNumber: interfaceNumber,
  96. Role: quecPortRole(interfaceNumber, name),
  97. }
  98. }
  99. if state.candidate.QMIControl == "" && len(qmiControls) > 0 {
  100. state.candidate.QMIControl = filepath.Join(d.DevRoot, qmiControls[0])
  101. }
  102. if state.candidate.NetworkInterface == "" && len(networkInterfaces) > 0 {
  103. state.candidate.NetworkInterface = networkInterfaces[0]
  104. }
  105. }
  106. result := make([]Candidate, 0, len(devices))
  107. for _, state := range devices {
  108. state.candidate.Ports = make([]Port, 0, len(state.ports))
  109. for _, port := range state.ports {
  110. state.candidate.Ports = append(state.candidate.Ports, port)
  111. }
  112. sort.Slice(state.candidate.Ports, func(i, j int) bool {
  113. left, right := state.candidate.Ports[i], state.candidate.Ports[j]
  114. if left.InterfaceNumber != right.InterfaceNumber {
  115. return left.InterfaceNumber < right.InterfaceNumber
  116. }
  117. return left.Name < right.Name
  118. })
  119. state.candidate.ATPort = selectATPort(state.candidate.Ports)
  120. result = append(result, state.candidate)
  121. }
  122. sort.Slice(result, func(i, j int) bool { return result[i].ID < result[j].ID })
  123. return result, nil
  124. }
  125. func parseUSBInterfaceName(name string) (int, bool) {
  126. _, suffix, ok := strings.Cut(name, ":")
  127. if !ok {
  128. return 0, false
  129. }
  130. _, numberText, ok := strings.Cut(suffix, ".")
  131. if !ok || numberText == "" {
  132. return 0, false
  133. }
  134. number, err := strconv.ParseInt(numberText, 10, 32)
  135. return int(number), err == nil
  136. }
  137. func readHexByte(path string) (int, error) {
  138. value := readTrimmed(path)
  139. number, err := strconv.ParseUint(value, 16, 8)
  140. return int(number), err
  141. }
  142. func readTrimmed(path string) string {
  143. value, err := os.ReadFile(path)
  144. if err != nil {
  145. return ""
  146. }
  147. return strings.TrimSpace(string(value))
  148. }
  149. func scanUSBInterface(root string) (ttyNames, qmiControls, networkInterfaces []string) {
  150. ttySeen := make(map[string]struct{})
  151. qmiSeen := make(map[string]struct{})
  152. netSeen := make(map[string]struct{})
  153. _ = filepath.WalkDir(root, func(path string, entry fs.DirEntry, err error) error {
  154. if err != nil {
  155. return nil
  156. }
  157. name := entry.Name()
  158. switch {
  159. case entry.IsDir() && (strings.HasPrefix(name, "ttyUSB") || strings.HasPrefix(name, "ttyACM")):
  160. ttySeen[name] = struct{}{}
  161. case strings.HasPrefix(name, "cdc-wdm"):
  162. qmiSeen[name] = struct{}{}
  163. case entry.IsDir() && filepath.Base(filepath.Dir(path)) == "net":
  164. netSeen[name] = struct{}{}
  165. }
  166. return nil
  167. })
  168. for name := range ttySeen {
  169. ttyNames = append(ttyNames, name)
  170. }
  171. for name := range qmiSeen {
  172. qmiControls = append(qmiControls, name)
  173. }
  174. for name := range netSeen {
  175. networkInterfaces = append(networkInterfaces, name)
  176. }
  177. sort.Strings(ttyNames)
  178. sort.Strings(qmiControls)
  179. sort.Strings(networkInterfaces)
  180. return
  181. }
  182. func readSerialAliases(root string) map[string]string {
  183. result := make(map[string]string)
  184. entries, err := os.ReadDir(root)
  185. if err != nil {
  186. return result
  187. }
  188. for _, entry := range entries {
  189. path := filepath.Join(root, entry.Name())
  190. target, err := os.Readlink(path)
  191. if err != nil {
  192. continue
  193. }
  194. name := filepath.Base(filepath.Clean(target))
  195. if strings.HasPrefix(name, "ttyUSB") || strings.HasPrefix(name, "ttyACM") {
  196. if existing := result[name]; existing == "" || path < existing {
  197. result[name] = path
  198. }
  199. }
  200. }
  201. return result
  202. }
  203. func candidateID(productID, serialNumber, usbName string) string {
  204. serialNumber = strings.TrimSpace(serialNumber)
  205. if serialNumber != "" && !strings.EqualFold(serialNumber, "android") {
  206. return "quectel-" + sanitizeID(serialNumber)
  207. }
  208. return "quectel-" + sanitizeID(productID+"-"+usbName)
  209. }
  210. func sanitizeID(value string) string {
  211. value = strings.ToLower(strings.TrimSpace(value))
  212. var result strings.Builder
  213. for _, character := range value {
  214. if character >= 'a' && character <= 'z' ||
  215. character >= '0' && character <= '9' ||
  216. character == '-' || character == '_' {
  217. result.WriteRune(character)
  218. } else {
  219. result.WriteByte('-')
  220. }
  221. }
  222. return strings.Trim(result.String(), "-")
  223. }
  224. func quecPortRole(interfaceNumber int, name string) PortRole {
  225. // Quectel exposes the same logical ports under more than one USB
  226. // composition. In both layouts seen on EC20/EC25 hardware the kernel
  227. // stable tty name is the stronger hint: ttyUSB0 is diagnostic and
  228. // ttyUSB2 is the primary AT port, even when their interface numbers are
  229. // 00/02 instead of 02/04.
  230. switch name {
  231. case "ttyUSB0":
  232. return PortRoleDiagnostic
  233. case "ttyUSB1":
  234. return PortRoleNMEA
  235. case "ttyUSB2":
  236. return PortRoleAT
  237. case "ttyUSB3":
  238. return PortRoleModem
  239. }
  240. switch interfaceNumber {
  241. case 0x02:
  242. return PortRoleDiagnostic
  243. case 0x03:
  244. return PortRoleNMEA
  245. case 0x04:
  246. return PortRoleAT
  247. case 0x05:
  248. return PortRoleModem
  249. default:
  250. if name == "ttyUSB2" {
  251. return PortRoleAT
  252. }
  253. return PortRoleUnknown
  254. }
  255. }
  256. func selectATPort(ports []Port) Port {
  257. var best Port
  258. bestScore := 0
  259. for _, port := range ports {
  260. score := 0
  261. switch {
  262. case port.Name == "ttyUSB2":
  263. score = 120
  264. case port.Role == PortRoleAT:
  265. score = 100
  266. case port.InterfaceNumber == 0x04:
  267. score = 90
  268. case port.InterfaceNumber == 0x05:
  269. score = 40
  270. case port.Role == PortRoleModem:
  271. score = 30
  272. }
  273. if score > bestScore {
  274. best, bestScore = port, score
  275. }
  276. }
  277. if bestScore <= 0 {
  278. return Port{}
  279. }
  280. return best
  281. }
  282. type unsupportedDiscoverer struct{}
  283. func (unsupportedDiscoverer) Discover(context.Context) ([]Candidate, error) {
  284. return nil, ErrUnsupportedPlatform
  285. }