pwmvar.h revision 1.1.2.2 1 1.1.2.2 pgoyette /* $NetBSD: pwmvar.h,v 1.1.2.2 2018/05/21 04:36:12 pgoyette Exp $ */
2 1.1.2.2 pgoyette
3 1.1.2.2 pgoyette /*-
4 1.1.2.2 pgoyette * Copyright (c) 2018 Jared McNeill <jmcneill (at) invisible.ca>
5 1.1.2.2 pgoyette * All rights reserved.
6 1.1.2.2 pgoyette *
7 1.1.2.2 pgoyette * Redistribution and use in source and binary forms, with or without
8 1.1.2.2 pgoyette * modification, are permitted provided that the following conditions
9 1.1.2.2 pgoyette * are met:
10 1.1.2.2 pgoyette * 1. Redistributions of source code must retain the above copyright
11 1.1.2.2 pgoyette * notice, this list of conditions and the following disclaimer.
12 1.1.2.2 pgoyette * 2. Redistributions in binary form must reproduce the above copyright
13 1.1.2.2 pgoyette * notice, this list of conditions and the following disclaimer in the
14 1.1.2.2 pgoyette * documentation and/or other materials provided with the distribution.
15 1.1.2.2 pgoyette *
16 1.1.2.2 pgoyette * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 1.1.2.2 pgoyette * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 1.1.2.2 pgoyette * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 1.1.2.2 pgoyette * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 1.1.2.2 pgoyette * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 1.1.2.2 pgoyette * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 1.1.2.2 pgoyette * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 1.1.2.2 pgoyette * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 1.1.2.2 pgoyette * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 1.1.2.2 pgoyette * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 1.1.2.2 pgoyette * SUCH DAMAGE.
27 1.1.2.2 pgoyette */
28 1.1.2.2 pgoyette
29 1.1.2.2 pgoyette #ifndef _DEV_PWM_PWMVAR_H
30 1.1.2.2 pgoyette #define _DEV_PWM_PWMVAR_H
31 1.1.2.2 pgoyette
32 1.1.2.2 pgoyette enum pwm_polarity {
33 1.1.2.2 pgoyette PWM_ACTIVE_HIGH,
34 1.1.2.2 pgoyette PWM_ACTIVE_LOW
35 1.1.2.2 pgoyette };
36 1.1.2.2 pgoyette
37 1.1.2.2 pgoyette struct pwm_config {
38 1.1.2.2 pgoyette u_int period; /* nanoseconds */
39 1.1.2.2 pgoyette u_int duty_cycle; /* nanoseconds */
40 1.1.2.2 pgoyette enum pwm_polarity polarity; /* PWM_ACTIVE_{HIGH,LOW} */
41 1.1.2.2 pgoyette };
42 1.1.2.2 pgoyette
43 1.1.2.2 pgoyette typedef struct pwm_controller {
44 1.1.2.2 pgoyette int (*pwm_enable)(struct pwm_controller *, bool);
45 1.1.2.2 pgoyette int (*pwm_get_config)(struct pwm_controller *,
46 1.1.2.2 pgoyette struct pwm_config *);
47 1.1.2.2 pgoyette int (*pwm_set_config)(struct pwm_controller *,
48 1.1.2.2 pgoyette const struct pwm_config *);
49 1.1.2.2 pgoyette
50 1.1.2.2 pgoyette device_t pwm_dev; /* device */
51 1.1.2.2 pgoyette void *pwm_priv; /* driver private data */
52 1.1.2.2 pgoyette } *pwm_tag_t;
53 1.1.2.2 pgoyette
54 1.1.2.2 pgoyette int pwm_enable(pwm_tag_t);
55 1.1.2.2 pgoyette int pwm_disable(pwm_tag_t);
56 1.1.2.2 pgoyette int pwm_get_config(pwm_tag_t, struct pwm_config *);
57 1.1.2.2 pgoyette int pwm_set_config(pwm_tag_t, const struct pwm_config *);
58 1.1.2.2 pgoyette
59 1.1.2.2 pgoyette #endif /* _DEV_PWM_PWMVAR_H */
60