oc_pwm.h File Reference

The file with interface for the PWM driver. More...

#include <oc_driver.h>
#include <oc_gpio.h>
#include <oc_frequency.h>

Go to the source code of this file.

Data Structures
struct	oC_PWM_Config_t
	PWM driver configuration structure. More...

Typedefs
typedef struct Context_t *	oC_PWM_Context_t
	The PWM context structure. More...

Detailed Description

---

Author

Patryk Kubiak

Note

Copyright (C) 2015 Patryk Kubiak patry.nosp@m.k.ku.nosp@m.biak9.nosp@m.0@gm.nosp@m.ail.c.nosp@m.om

Copyright

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Definition in file oc_pwm.h.

Typedef Documentation

typedef struct Context_t* oC_PWM_Context_t

This is the structure with dynamic allocated data for the PWM. It stores a HANDLE for a driver and it can be used to identify the driver context. You should get this pointer from the #oC_PWM_Configure function, but note, that not all drivers use it. In many cases it is just not needed, and it just will store NULL then. You should keep this pointer as long as it is necessary for you, and when it will not be anymore, you should call #oC_PWM_Unconfigure function to destroy it.

Definition at line 80 of file oc_pwm.h.