JME(4)

πŸ’– JME(4) β€” the jme girlies' field guide πŸ’–

okay bestie, sit down, hydrate, because we're talking about the jme driver β€” the JMicron Gigabit/Fast Ethernet driver β€” and it's giving networking icon energy. this is a Kernel Interfaces Manual page, so like, very serious, very official, but we're gonna make it cute. πŸŽ€


✨ NAME ✨

jme β€” the JMicron Gigabit/Fast Ethernet driver. that's her. that's the whole name. slay. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

so you wanna get this driver into your kernel? no cap, it's easy. drop these lines in your kernel configuration file:

device miibus
device jme

or, if you're more of a "load it at boot like a module" kinda girl (valid!), put this line in loader.conf(5):

if_jme_load="YES"

boom. done. ✨


🌸 DESCRIPTION 🌸

the jme device driver provides support for JMicron JMC25x PCI Express Gigabit Ethernet controllers and JMicron JMC26x PCI Express Fast Ethernet controllers. two controller families, one iconic driver, we love to see it. πŸ‘‘

and listen β€” all the LOMs supported by jme are absolutely stacked, no crumbs. they all have:

  • TCP/UDP/IP checksum offload for both transmit and receive (both!! balanced!!)
  • TCP segmentation offload (TSO)
  • hardware VLAN tag stripping/insertion features
  • Wake On Lan (WOL) β€” yes she can wake you up, respectfully
  • an interrupt coalescing/moderation mechanism
  • a 64-bit multicast hash filter

the JMC25x is the overachiever of the family and also supports Jumbo Frames (up to 9216 bytes), which you configure via the interface MTU setting. if you select an MTU larger than 1500 bytes with the ifconfig(8) utility, you're configuring the adapter to receive and transmit Jumbo Frames. periodt. 🫢

πŸ’« media types she supports πŸ’«

  • autoselect β€” enables autoselection of the media type and options. you can manually override the autoselected mode by adding media options to rc.conf(5). letting her choose, but you can step in. main character energy.
  • 10baseT/UTP β€” set 10Mbps operation. slow and steady, still valid.
  • 100baseTX β€” set 100Mbps (Fast Ethernet) operation.
  • 1000baseTX β€” set 1000baseTX operation over twisted pair. gigabit babe.

πŸ’… media options πŸ’…

  • full-duplex β€” force full duplex operation.
  • half-duplex β€” force half duplex operation.

for more info on configuring this device, see ifconfig(8). iykyk. 🌈


πŸ‘‘ HARDWARE πŸ‘‘

the jme device driver provides support for the following Ethernet controllers:

  • JMicron JMC250 PCI Express Gigabit Ethernet controller
  • JMicron JMC251 PCI Express Gigabit Ethernet with Card Read Host controller
  • JMicron JMC260 PCI Express Fast Ethernet controller
  • JMicron JMC261 PCI Express Gigabit Ethernet with Card Read Host controller

four icons. a whole squad. 🧚


πŸ”₯ LOADER TUNABLES πŸ”₯

tunables can be set at the loader(8) prompt before booting the kernel, or stored in loader.conf(5). your choice, bestie, both are valid.

  • hw.jme.msi_disable β€” this tunable disables MSI support on the Ethernet hardware. the default value is 0.
  • hw.jme.msix_disable β€” this tunable disables MSI-X support on the Ethernet hardware. the default value is 0.

⭐ SYSCTL VARIABLES ⭐

the following variables are available as both sysctl(8) variables and loader(8) tunables. double duty, she's versatile. πŸ’œ

  • dev.jme.%d.tx_coal_to β€” this variable sets the maximum amount of time to delay before sending a Tx completion interrupt, in microseconds. the accepted range is 1 to 65535; the default is 100 (100us).
  • dev.jme.%d.tx_coal_pkt β€” this variable sets the maximum number of outgoing packets which may be coalesced together into a single Tx completion interrupt. the accepted range is 1 to 255; the default is 8.
  • dev.jme.%d.rx_coal_to β€” this variable sets the maximum amount of time to wait for additional packets to arrive (for possible packet coalescing) before firing an Rx completion interrupt, in microseconds. the accepted range is 1 to 65535; the default is 100 (100us).
  • dev.jme.%d.rx_coal_pkt β€” this variable sets the maximum number of incoming packets which may be coalesced into a single Rx completion interrupt. the accepted range is 1 to 255; the default is 2.
  • dev.jme.%d.process_limit β€” this variable sets the maximum number of events that will be processed in a single batch before the handler is requeued into a taskqueue. the accepted range is 10 to 255; the default value is 128 events. the interface does not need to be brought down and up again before a change takes effect. (no dramatic restart required, we love a low-maintenance queen ✨)

🌈 SEE ALSO 🌈

altq(4), arp(4), miibus(4), netintro(4), ng_ether(4), vlan(4), ifconfig(8)

go read those too, they're all part of the extended universe bestie πŸ“š


πŸ’– HISTORY πŸ’–

the jme driver was written by Pyun YongHyeon <yongari@FreeBSD.org>. it first appeared in FreeBSD 7.1. a legend, an origin story, we stan. 🫢


😭 CAVEATS 😭

okay bestie this is the part where we get serious, because this is the do not play with this section. no cap.

the eFuse thing. read this twice.

the jme driver tries to avoid unnecessary station address reprogramming for controllers that use eFuse to store station address. the number of times that eFuse can be safely reprogrammed is 16 at most. and it gets worse: there is no way to restore the factory default station address once the station address has been reprogrammed via eFuse.

it is highly recommended not to reprogram the station address, and it is the responsibility of the administrator to store the original station address in a safe place when station address is changed. like, screenshot it, write it on a sticky note, tattoo it, whatever β€” just don't lose it. πŸ’€

the 1000baseT link drama. two known issues with JMC25x.
  1. If the full mask revision number of the JMC25x controller is less than or equal to 4 and the link partner enabled the IEEE 802.3az Energy Efficient Ethernet feature, the controller will not be able to establish a 1000baseT link.
  2. Also, if the length of the cable is longer than 120 meters, the controller can not establish a 1000baseT link.

the known workaround for these issues is to force manual link configuration with 100baseTX instead of relying on auto-negotiation. not ideal, but it works, and we adapt. πŸ’…

the full mask revision number of the controller can be checked with the verbose kernel boot option. use the lower nibble of the chip revision number to get the full mask revision of the controller. tiny detail, big consequences. πŸ™ˆ


and that's the whole page, bestie!! this was the JME(4) manpage from the Debian crew, dated March 4, 2012 β€” vintage but still serving. go forth, configure your ethernet, and remember: back up that station address. mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from