@@ -23,6 +23,9 @@ PktUART ports.
2323 if *debug* is set to a positive value between 0 and 5, where 0 means no
2424 messages at all and 5 means everything. A value of -1 does not touch the
2525 current message level. +
26+ Warning: setting *debug* to 0 (zero) will prevent any messages from being
27+ printed. Not even errors will be printed when you set it to zero and you may
28+ end up guessing why things went wrong. +
2629 Caveat Emptor: the driver must be compiled with debug messages enabled for it
2730 to start emitting messages at the debug level. Changing the message level is
2831 process-wide and all modules within the process will spit out messages at the
@@ -45,8 +48,28 @@ delay measurements. Warnings will be emitted if communication settings cannot
4548be honored by the older PktUART version. PktUART versions older than 2 are not
4649supported and the driver will abort with an error if encountered.
4750
48- The driver exports a set of HAL pins and parameters that can be used to inspect
49- status and alter some settings in a live environment.
51+ Please note, the hostmot2 software will automatically create all nodes for
52+ all available devices in the board's bit-file. The PktUART nodes will be
53+ named 'pktuart.0', 'pktuart.1', etc.. You can see what your bit-file supports
54+ by using the *mesaflash*(1) utility (please adapt for your board and IP
55+ address accordingly):
56+
57+ [source,sh]
58+ ----
59+ sudo mesaflash --device 7i96s --addr 10.10.10.10 --readhmid
60+ ----
61+
62+ The *hostmot2* module should automatically print the name(s) of any PktUART
63+ found while the board's configuration is being traversed. You can check this on
64+ the command line by looking for lines like:
65+
66+ [source,text]
67+ ----
68+ hm2/hm2_7i96s.0: created PktUART Interface function hm2_7i96s.0.pktuart.0.
69+ ----
70+
71+ The *hm2_modbus* driver exports a set of HAL pins and parameters that can be
72+ used to inspect status and alter some settings in a live environment.
5073
5174Up to eight instances are supported, which are instantiated by setting
5275the *ports* and *mbccbs* parameters. The instances are
@@ -55,7 +78,7 @@ driver will always be prefixed with the driver's name.
5578
5679[source,sh]
5780----
58- loadrt hm2_modbus ports="7i96s .0.pktuart.0" mbccbs="/path/to/myfile.mbccb"
81+ loadrt hm2_modbus ports="hm2_7i96s .0.pktuart.0" mbccbs="/path/to/myfile.mbccb"
5982----
6083
6184The driver exports one function named 'process', which must be added to the
@@ -180,7 +203,8 @@ Each mbccb file will generate a set of pins as defined in the mbccb file. See
180203== SEE ALSO
181204
182205*hostmot2*(9),
183- *mesambccc*(1).
206+ *mesambccc*(1),
207+ *mesaflash*(1).
184208
185209== AUTHOR
186210
0 commit comments