freebsd-dev/usr.sbin/pwm/pwm.c

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org>
 * All rights reserved.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE 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 THE 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.
 *
 * $FreeBSD$
 */

#include <sys/types.h>
#include <sys/ioctl.h>
#include <stdbool.h>
#include <sys/pwm.h>
#include <sys/capsicum.h>

#include <err.h>
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <capsicum_helpers.h>

#define	PWM_ENABLE	0x0001
#define	PWM_DISABLE	0x0002
#define	PWM_SHOW_CONFIG	0x0004
#define	PWM_PERIOD	0x0008
#define	PWM_DUTY	0x0010

static void
usage(void)
{
	fprintf(stderr, "Usage:\n");
	fprintf(stderr, "\tpwm [-f dev] -c channel -E\n");
	fprintf(stderr, "\tpwm [-f dev] -c channel -D\n");
	fprintf(stderr, "\tpwm [-f dev] -c channel -C\n");
	fprintf(stderr, "\tpwm [-f dev] -c channel -p period\n");
	fprintf(stderr, "\tpwm [-f dev] -c channel -d duty\n");
	exit(1);
}

int
main(int argc, char *argv[])
{
	struct pwm_state state;
	int fd;
	int channel, nchannels;
	int period, duty;
	int action, ch;
	cap_rights_t right_ioctl;
	const unsigned long pwm_ioctls[] = {PWMGETSTATE, PWMSETSTATE, PWMMAXCHANNEL};

	action = 0;
	fd = -1;
	channel = -1;
	period = duty = -1;

	while ((ch = getopt(argc, argv, "f:c:EDCp:d:")) != -1) {
		switch (ch) {
		case 'E':
			if (action)
				usage();
			action = PWM_ENABLE;
			break;
		case 'D':
			if (action)
				usage();
			action = PWM_DISABLE;
			break;
		case 'C':
			if (action)
				usage();
			action = PWM_SHOW_CONFIG;
			break;
		case 'p':
			if (action & ~(PWM_PERIOD | PWM_DUTY))
				usage();
			action = PWM_PERIOD;
			period = strtol(optarg, NULL, 10);
			break;
		case 'd':
			if (action & ~(PWM_PERIOD | PWM_DUTY))
				usage();
			action = PWM_DUTY;
			duty = strtol(optarg, NULL, 10);
			break;
		case 'c':
			if (channel != -1)
				usage();
			channel = strtol(optarg, NULL, 10);
			break;
		case 'f':
			if ((fd = open(optarg, O_RDWR)) < 0) {
				fprintf(stderr, "pwm: cannot open %s %s\n",
				  optarg, strerror(errno));
				exit(1);
			}
		}
	}

	if (fd == -1) {
		if ((fd = open("/dev/pwmc0", O_RDWR)) < 0) {
			fprintf(stderr, "pwm: cannot open %s %s\n",
			    optarg, strerror(errno));
			exit(1);
		}
	}

	if (action == 0 || fd == -1)
		usage();

	if (caph_limit_stdio() < 0) {
		fprintf(stderr, "can't limit stdio rights");
		goto fail;
	}
	caph_cache_catpages();
	cap_rights_init(&right_ioctl, CAP_IOCTL);
	if (caph_rights_limit(fd, &right_ioctl) < 0) {
		fprintf(stderr, "cap_right_limit() failed\n");
		goto fail;
	}
	if (caph_ioctls_limit(fd, pwm_ioctls, nitems(pwm_ioctls)) < 0) {
		fprintf(stderr, "caph_ioctls_limit() failed\n");
		goto fail;
	}
	if (caph_enter() < 0) {
		fprintf(stderr, "failed to enter capability mode\n");
		goto fail;
	}

	/* Check if the channel is correct */
	if (ioctl(fd, PWMMAXCHANNEL, &nchannels) == -1) {
		fprintf(stderr, "ioctl: %s\n", strerror(errno));
		goto fail;
	}
	if (channel > nchannels) {
		fprintf(stderr, "pwm controller only support %d channels\n",
		    nchannels);
		goto fail;
	}

	/* Fill the common args */
	state.channel = channel;
	if (ioctl(fd, PWMGETSTATE, &state) == -1) {
		fprintf(stderr, "Cannot get current state of the pwm controller\n");
		goto fail;
	}

	switch (action) {
	case PWM_ENABLE:
		if (state.enable == false) {
			state.enable = true;
			if (ioctl(fd, PWMSETSTATE, &state) == -1) {
				fprintf(stderr,
				    "Cannot enable the pwm controller\n");
				goto fail;
			}
		}
		break;
	case PWM_DISABLE:
		if (state.enable == true) {
			state.enable = false;
			if (ioctl(fd, PWMSETSTATE, &state) == -1) {
				fprintf(stderr,
				    "Cannot disable the pwm controller\n");
				goto fail;
			}
		}
		break;
	case PWM_SHOW_CONFIG:
		printf("period: %ju\nduty: %ju\nenabled:%d\n",
		    (uintmax_t) state.period,
		    (uintmax_t) state.duty,
		    state.enable);
		break;
	case PWM_PERIOD:
	case PWM_DUTY:
		if (period != -1)
			state.period = period;
		if (duty != -1)
			state.duty = duty;
		if (ioctl(fd, PWMSETSTATE, &state) == -1) {
			fprintf(stderr,
			  "Cannot configure the pwm controller\n");
			goto fail;
		}
		break;
	}

	close(fd);
	return (0);

fail:
	close(fd);
	return (1);
}