Mellanox as an HW vendor in FreeBSD 9.x (and above) HW notes

[Rodney W. Grimes]

> We have man page for mlx5en on FreeBSD 10.x, 11.x and 12.x
> We also have mlx4en and mlx4ib on 12.x
fb-srv-nas1.dnsmgr.net:root {1005}# man mlx4ib
No manual entry for mlx4ib
fb-srv-nas1.dnsmgr.net:root {1006}# uname -a
FreeBSD fb-srv-nas1.dnsmgr.net 12.0-CURRENT FreeBSD 12.0-CURRENT #0 r309361: Thu Dec 22 15:00:44 UTC 2016     root at fb-bld-amd64-current.dnsmgr.net:/usr/src/sys/amd64/compile/CUSTOMAMD64NAS  amd64
Is mlx4ib a recent addition ??

> 
> We'll work on adding the missing man pages.

That would be wonderful. 

> What would be the next step?

Insure that your manual pages have the section that man2hwnotes.pl is looking for.
I do see what looks correct in mlx4en.4.

I think I spotted one problem, much of the infiniband stuff is not built or
installed on a system unless WITH_OFED is defined, 

It could be that since Infiniband does not work out of the box without
a buildworld that these items have been opted out of the release notes.
I do see that mlx4.ko mlx4en.ko mlx5.ko mlx5en.ko are built on a -current
system, so those should show up in the hardware list.

The others (mlx4ib, mthca) are hidden behind a MAKE_OFED.

As someone else stated a patch to release/doc/en_US.ISO8859-1/hardware/article.xml
adding the hwlist.<drivername> entries well be needed.

> -Meny
> 
> 
> -----Original Message-----
> From: Rodney W. Grimes [mailto:freebsd at pdx.rh.CN85.dnsmgr.net] 
> Sent: Sunday, January 29, 2017 9:19 PM
> To: Meny Yossefi <menyy at mellanox.com>
> Cc: Benjamin Kaduk <kaduk at mit.edu>; doc at FreeBSD.org; re at FreeBSD.org; Hans Petter Selasky <hanss at mellanox.com>
> Subject: Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW notes
> 
> Having just recently started to play with Mellanox HW I can say that most likely the cause of not getting in the release notes are there are NO manual pages for the Mellanox drivers.
> 
> So my guess would be the first step is to write section 4 manual pages for mtcha(4), mlx4(4), mlx5(4), mlx4en(4), mlx4ib(4), ... etc
> 
> > Thanks Ben.
> > 
> > I got no response from re at Freebsd. 
> > 
> > Is there a specific person you can refer me to? 
> > 
> > -Meny
> > 
> > 
> > -----Original Message-----
> > From: Benjamin Kaduk [mailto:kaduk at mit.edu]
> > Sent: Sunday, January 15, 2017 11:42 PM
> > To: Meny Yossefi <menyy at mellanox.com>
> > Cc: doc at FreeBSD.org; Hans Petter Selasky <hanss at mellanox.com>; 
> > re at FreeBSD.org
> > Subject: Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW 
> > notes
> > 
> > On Sun, Jan 15, 2017 at 03:38:06PM +0000, Meny Yossefi wrote:
> > > Hi,
> > > 
> > > My name is Meny and I'm leading Mellanox's FreeBSD team these days, developing Ethernet and InfiniBand drivers for our ConnectX NICs.
> > > 
> > > We came across the FreeBSD 11.0 hardware notes and found that we were not included in the list although we have an Ethernet and InfiniBand driver since FreeBSD 9.1.
> > > 
> > > https://www.freebsd.org/releases/11.0R/relnotes.html
> > > 
> > > 
> > > Can you please let me know what is the procedure for adding us as a vendor?
> > 
> > As I understand it, the hardware notes are generated automatically via certain portions of certain manual pages.
> > 
> > It looks like that takes the form of &hwlist.<drivername>; entities in
> > (e.g.) ^/base/head/release/doc/en_US.ISO8859-1/hardware/article.xml, with the hwlist entities being generated by ^/base/head/release/doc/share/misc/man2hwnotes.pl.  I don't know offhand whether mlx5en.4 is formatted properly for that script, but it seems that at a minimum, the &hwlist.mlx5en; entity needs to be added to the release notes sources.
> > 
> > I've cc'd re at FreeBSD.org, since they have change control over the release notes and would need to make or approve such a change.
> > 
> > -Ben
> > 
> > 
> 
> -- 
> Rod Grimes                                                 rgrimes at freebsd.org
> 
> 

-- 
Rod Grimes                                                 rgrimes at freebsd.org