Paths

Table of Contentst

-
lib/libsys/
-
libsys/
-
kqueue.2

Differential D48203

kqueue.2: Editorial pass
ClosedPublic
Actions

Authored by jhb on Dec 26 2024, 8:12 PM.

Details

Reviewers

emaste

Commits

rG8e8058b7373b: kqueue.2: Editorial pass
rG9b1585384d53: kqueue.2: Editorial pass

Summary

Use consistent language to describe user values unchanged by the kernel.

Replace passive language with active in a few places.

Add a history note for kqueuex().

Various wording and markup tweaks.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 61336
Build 58220: arc lint + arc unit

Event Timeline

jhb created this revision.Dec 26 2024, 8:12 PM

Herald added a subscriber: imp. · View Herald TranscriptDec 26 2024, 8:12 PM

jhb requested review of this revision.Dec 26 2024, 8:12 PM

Harbormaster completed remote builds in B61336: Diff 148406.Dec 26 2024, 8:12 PM

OK, one little note.

lib/libsys/kqueue.2
116	The "also" here seems somewhat out of place to me for some reason but I'm not quite sure why. Maybe "Also, for compatibility with NetBSD the..." or "The kqueue1 function is also provided, for compatibility with NetBSD. It accepts..."

This revision is now accepted and ready to land.Dec 28 2024, 5:19 PM

Tweak kqueue1 language

This revision now requires review to proceed.Dec 30 2024, 3:51 PM

Harbormaster completed remote builds in B61406: Diff 148553.Dec 30 2024, 3:51 PM

emaste accepted this revision.Dec 30 2024, 4:22 PM

This revision is now accepted and ready to land.Dec 30 2024, 4:22 PM

Closed by commit rG9b1585384d53: kqueue.2: Editorial pass (authored by jhb). · Explain WhyDec 30 2024, 7:10 PM

This revision was automatically updated to reflect the committed changes.

jhb added a commit: rG9b1585384d53: kqueue.2: Editorial pass.

jhb added a commit: rG8e8058b7373b: kqueue.2: Editorial pass.Mar 3 2025, 4:57 PM

Herald added a subscriber: ziaee. · View Herald TranscriptMar 3 2025, 4:57 PM

Revision Contents
Changeset List

Path

Size

lib/

libsys/

kqueue.2

48 lines

Diff 148406

View Options

lib/libsys/kqueue.2

This file was added.

				/*-
				* Copyright (C) 2008 MARVELL INTERNATIONAL LTD.
				* All rights reserved.
				*
				* Developed by Semihalf.
				*
				* Redistribution and use in source and binary forms, with or without
				* modification, are permitted provided that the following conditions
				* are met:
				* 1. Redistributions of source code must retain the above copyright
				* notice, this list of conditions and the following disclaimer.
				* 2. Redistributions in binary form must reproduce the above copyright
				* notice, this list of conditions and the following disclaimer in the
				* documentation and/or other materials provided with the distribution.
				* 3. Neither the name of MARVELL nor the names of contributors
				* may be used to endorse or promote products derived from this software
				* without specific prior written permission.
				*
				* THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
				* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
				* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
				* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
				* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
				* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
				* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
				* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
				* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
				* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
				* SUCH DAMAGE.
				*/

				/*
				* Driver for the TWSI (aka I2C, aka IIC) bus controller found on Marvell
				* and Allwinner SoCs. Supports master operation only, and works in polling mode.
				*
				* Calls to DELAY() are needed per Application Note AN-179 "TWSI Software
				* Guidelines for Discovery(TM), Horizon (TM) and Feroceon(TM) Devices".
				*/

				#include <sys/cdefs.h>
				__FBSDID("$FreeBSD$");

				#include <sys/param.h>
				#include <sys/systm.h>
				#include <sys/bus.h>
				#include <sys/kernel.h>
				#include <sys/module.h>
				#include <sys/resource.h>

				#include <machine/_inttypes.h>
				#include <machine/bus.h>
				#include <machine/resource.h>

				#include <sys/rman.h>

				#include <sys/lock.h>
				#include <sys/mutex.h>

				#include <dev/iicbus/iiconf.h>
				#include <dev/iicbus/iicbus.h>
				#include <dev/fdt/fdt_common.h>
				#include <dev/ofw/ofw_bus.h>
				#include <dev/ofw/ofw_bus_subr.h>

				#include <arm/mv/mvreg.h>
				#include <arm/mv/mvvar.h>
				#include <dev/iicbus/twsi/twsi.h>

				#include "iicbus_if.h"

				#define MV_TWSI_NAME "twsi"
				#define IICBUS_DEVNAME "iicbus"

				#define TWSI_ADDR 0x00
				#define TWSI_DATA 0x04
				#define TWSI_CNTR 0x08
				#define TWSI_XADDR 0x10
				#define TWSI_STAT 0x0c
				#define TWSI_BAUD_RATE 0x0c
				#define TWSI_SRST 0x1c

				#define TWSI_BAUD_RATE_RAW(C,M,N) ((C)/((10*(M+1))<<(N+1)))
				#define TWSI_BAUD_RATE_SLOW 50000 /* 50kHz */
				#define TWSI_BAUD_RATE_FAST 100000 /* 100kHz */

				#define TWSI_DEBUG
				#undef TWSI_DEBUG

				#ifdef TWSI_DEBUG
				#define debugf(fmt, args...) do { printf("%s(): ", __func__); printf(fmt,##args); } while (0)
				#else
				#define debugf(fmt, args...)
				#endif

				static int mv_twsi_probe(device_t);
				static int mv_twsi_attach(device_t);

				static struct ofw_compat_data compat_data[] = {
				{ "mrvl,twsi", true },
				{ "marvell,mv64xxx-i2c", true },
				{ NULL, false }
				};

				static device_method_t mv_twsi_methods[] = {
				/* device interface */
				DEVMETHOD(device_probe, mv_twsi_probe),
				DEVMETHOD(device_attach, mv_twsi_attach),

				{ 0, 0 }
				};

				DEFINE_CLASS_1(twsi, mv_twsi_driver, mv_twsi_methods,
				sizeof(struct twsi_softc), twsi_driver);

				static devclass_t mv_twsi_devclass;

				DRIVER_MODULE(twsi, simplebus, mv_twsi_driver, mv_twsi_devclass, 0, 0);
				DRIVER_MODULE(iicbus, twsi, iicbus_driver, iicbus_devclass, 0, 0);
				MODULE_DEPEND(twsi, iicbus, 1, 1, 1);

				static int
				mv_twsi_probe(device_t dev)
				{
				struct twsi_softc *sc;

				sc = device_get_softc(dev);
				if (!ofw_bus_status_okay(dev))
				return (ENXIO);

				if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
				return (ENXIO);

				sc->reg_data = TWSI_DATA;
				sc->reg_slave_addr = TWSI_ADDR;
				sc->reg_slave_ext_addr = TWSI_XADDR;
				sc->reg_control = TWSI_CNTR;
				sc->reg_status = TWSI_STAT;
				sc->reg_baud_rate = TWSI_BAUD_RATE;
				sc->reg_soft_reset = TWSI_SRST;

				device_set_desc(dev, "Marvell Integrated I2C Bus Controller");
				return (BUS_PROBE_DEFAULT);
				}

				#define ABSSUB(a,b) (((a) > (b)) ? (a) - (b) : (b) - (a))
				static void
				mv_twsi_cal_baud_rate(const uint32_t target, struct twsi_baud_rate *rate)
				{
				uint32_t clk, cur, diff, diff0;
				int m, n, m0, n0;

				/* Calculate baud rate. */
				m0 = n0 = 4; /* Default values on reset */
				diff0 = 0xffffffff;
				clk = get_tclk();

				for (n = 0; n < 8; n++) {
				for (m = 0; m < 16; m++) {
				cur = TWSI_BAUD_RATE_RAW(clk,m,n);
				diff = ABSSUB(target, cur);
				if (diff < diff0) {
				m0 = m;
				n0 = n;
				diff0 = diff;
				}
				}
				}
				rate->raw = TWSI_BAUD_RATE_RAW(clk, m0, n0);
				rate->param = TWSI_BAUD_RATE_PARAM(m0, n0);
				rate->m = m0;
				rate->n = n0;
				}

				static int
				mv_twsi_attach(device_t dev)
				{
				struct twsi_softc *sc;
				phandle_t child, iicbusnode;
				device_t childdev;
				struct iicbus_ivar *devi;
				char dname[32]; /* 32 is taken from struct u_device */
				uint32_t paddr;
				int len, error;

				sc = device_get_softc(dev);

				mv_twsi_cal_baud_rate(TWSI_BAUD_RATE_SLOW, &sc->baud_rate[IIC_SLOW]);
				mv_twsi_cal_baud_rate(TWSI_BAUD_RATE_FAST, &sc->baud_rate[IIC_FAST]);
				if (bootverbose)
				device_printf(dev, "calculated baud rates are:\n"
				" %" PRIu32 " kHz (M=%d, N=%d) for slow,\n"
				" %" PRIu32 " kHz (M=%d, N=%d) for fast.\n",
				sc->baud_rate[IIC_SLOW].raw / 1000,
				sc->baud_rate[IIC_SLOW].m,
				sc->baud_rate[IIC_SLOW].n,
				sc->baud_rate[IIC_FAST].raw / 1000,
				sc->baud_rate[IIC_FAST].m,
				sc->baud_rate[IIC_FAST].n);


				twsi_attach(dev);

				iicbusnode = 0;
				/* Find iicbus as the child devices in the device tree. */
				for (child = OF_child(ofw_bus_get_node(dev)); child != 0;
				child = OF_peer(child)) {
				len = OF_getproplen(child, "model");
				if (len <= 0 \|\| len > sizeof(dname))
				continue;
				error = OF_getprop(child, "model", &dname, len);
				if (error == -1)
				continue;
				len = strlen(dname);
				if (len == strlen(IICBUS_DEVNAME) &&
				strncasecmp(dname, IICBUS_DEVNAME, len) == 0) {
				iicbusnode = child;
				break;
				}
				}
				if (iicbusnode == 0)
				goto attach_end;

				/* Attach child devices onto iicbus. */
				for (child = OF_child(iicbusnode); child != 0; child = OF_peer(child)) {
				/* Get slave address. */
				error = OF_getprop(child, "i2c-address", &paddr, sizeof(paddr));
				if (error == -1)
				error = OF_getprop(child, "reg", &paddr, sizeof(paddr));
				if (error == -1)
				continue;

				/* Get device driver name. */
				len = OF_getproplen(child, "model");
				if (len <= 0 \|\| len > sizeof(dname))
				continue;
				andrewUnsubmitted Done Inline Actions This is unneeded, and may overflow `dname`. `OF_getprop` already includes the null terminator. andrew: This is unneeded, and may overflow `dname`. `OF_getprop` already includes the null terminator.
				OF_getprop(child, "model", &dname, len);

				if (bootverbose)
				device_printf(dev, "adding a device %s at %d.\n",
				dname, fdt32_to_cpu(paddr));
				childdev = BUS_ADD_CHILD(sc->iicbus, 0, dname, -1);
				devi = IICBUS_IVAR(childdev);
				devi->addr = fdt32_to_cpu(paddr);
				}

				attach_end:
				bus_generic_attach(sc->iicbus);

				return (0);
				}
				andrewUnsubmitted Done Inline Actions And here andrew: And here

kqueue.2: Editorial passClosedPublicActions