nz_pwm.h

Go to the documentation of this file.

#ifndef _NZDEFAULT_PWM_H_
#define _NZDEFAULT_PWM_H_

#if defined(HAS_NZ_PWM)

#if (defined(__PIC24F__)) && defined(__C30__)   // Microchip C30 compiler
    #include "PPS.h"
#elif defined(__dsPIC33F__) && defined(__C30__) // Microchip C30 compiler
#elif defined(__PIC32MX__)                      // Microchip C32 compiler
#else
    #error Unknown processor or compiler.  See Compiler.h
#endif


//The PWM clock is configured by this module to be 16MHz, giving a 62.5ns period
#define PWM_CLOCK_FREQ      (GetInstructionClock())
#define PWM_CLOCK_PERIOD    (1/GetInstructionClock())

typedef struct {
    WORD OCxCON1;
    WORD OCxCON2;
    WORD OCxRS;     //Period, pwm will count from 0 to OCxRS
    WORD OCxR;      //Duty Cycles
    WORD OCxTMR;
} REGS_OC_;

//For other chips, check OC1CON1 is at address 0x0190, and all OC registers follow each other from 0x0190 to 0x01E8
#if defined(__PIC24FJ128GB106__) || defined(__PIC24FJ256GB106__) || defined(__PIC24FJ256GB206__)
    extern volatile REGS_OC_ __attribute__ ((sfr(0x0190))) regs_oc_[9];
#elif defined(__PIC32MX__)                      // Microchip C32 compiler
    // TODO for PIC32MX - this code WILL NOT WORK!!!! Just here so it compiles & for testing!
    extern volatile REGS_OC_ regs_oc_[9];
#else
    #error "nz_pwm no processor defined!"
#endif

#define PWM_FREQ_320HZ  49999

#define PWM_FREQ_1600HZ  9999

#define PWM_FREQ_3200HZ   4999

#define PWM_FREQ_8KHZ   1999

#define PWM_FREQ_16KHZ   999

#define PWM_FREQ_80KHZ  199

#define PWM_FREQ_160KHZ  99

#ifndef PWM1_FREQ
#define PWM1_FREQ       PWM_FREQ_16KHZ
#endif

#ifndef PWM2_FREQ
#define PWM2_FREQ        PWM_FREQ_16KHZ
#endif

#ifndef PWM3_FREQ
#define PWM3_FREQ       PWM_FREQ_16KHZ
#endif

#ifndef PWM4_FREQ
#define PWM4_FREQ       PWM_FREQ_16KHZ
#endif

#ifndef PWM5_FREQ
#define PWM5_FREQ       PWM_FREQ_16KHZ
#endif

#ifndef PWM6_FREQ
#define PWM6_FREQ       PWM_FREQ_16KHZ
#endif

#ifndef PWM7_FREQ
#define PWM7_FREQ       PWM_FREQ_16KHZ
#endif

#ifndef PWM8_FREQ
#define PWM8_FREQ       PWM_FREQ_16KHZ
#endif

#ifndef PWM9_FREQ
#define PWM9_FREQ       PWM_FREQ_16KHZ
#endif


#define PWM_CALCULATE_PERIOD_FOR_FREQUENCY(f) ((PWM_CLOCK_FREQ/f)-1)


#define pwm1OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC1; pwmOpenDefault(1, PWM1_FREQ, inverted);}

#define pwm2OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC2; pwmOpenDefault(2, PWM2_FREQ, inverted);}

#define pwm3OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC3; pwmOpenDefault(3, PWM3_FREQ, inverted);}

#define pwm4OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC4; pwmOpenDefault(4, PWM4_FREQ, inverted);}

#define pwm5OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC5; pwmOpenDefault(5, PWM5_FREQ, inverted);}

#define pwm6OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC6; pwmOpenDefault(6, PWM6_FREQ, inverted);}

#define pwm7OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC7; pwmOpenDefault(6, PWM7_FREQ, inverted);}

#define pwm8OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC8; pwmOpenDefault(8, PWM8_FREQ, inverted);}

#define pwm9OpenDefault(ppsOut, inverted) {ppsOut = OUT_FN_PPS_OC9; pwmOpenDefault(9, PWM9_FREQ, inverted);}

void pwmOpenDefault(BYTE chan, WORD period, BYTE inverted);


#define pwm1SetPeriod(period)  pwmSetPeriod(1, period)
#define pwm2SetPeriod(period)  pwmSetPeriod(2, period)
#define pwm3SetPeriod(period)  pwmSetPeriod(3, period)
#define pwm4SetPeriod(period)  pwmSetPeriod(4, period)
#define pwm5SetPeriod(period)  pwmSetPeriod(5, period)
#define pwm6SetPeriod(period)  pwmSetPeriod(6, period)
#define pwm7SetPeriod(period)  pwmSetPeriod(7, period)
#define pwm8SetPeriod(period)  pwmSetPeriod(8, period)
#define pwm9SetPeriod(period)  pwmSetPeriod(9, period)


void pwmSetPeriod(BYTE chan, WORD period);


WORD pwmGetPeriod(BYTE chan);


#define pwm1GetPeriod() (OC1RS)
#define pwm2GetPeriod() (OC2RS)
#define pwm3GetPeriod() (OC3RS)
#define pwm4GetPeriod() (OC4RS)
#define pwm5GetPeriod() (OC5RS)
#define pwm6GetPeriod() (OC6RS)
#define pwm7GetPeriod() (OC7RS)
#define pwm8GetPeriod() (OC8RS)
#define pwm9GetPeriod() (OC9RS)


void pwmSetFreqAndDutyCycle(BYTE chan, float freq, float dc);


float pwmGetFrequency(BYTE chan);


#define pwm1SetDutyCycle(dc)  pwmSetDutyCycle(1, dc)
#define pwm2SetDutyCycle(dc)  pwmSetDutyCycle(2, dc)
#define pwm3SetDutyCycle(dc)  pwmSetDutyCycle(3, dc)
#define pwm4SetDutyCycle(dc)  pwmSetDutyCycle(4, dc)
#define pwm5SetDutyCycle(dc)  pwmSetDutyCycle(5, dc)
#define pwm6SetDutyCycle(dc)  pwmSetDutyCycle(6, dc)
#define pwm7SetDutyCycle(dc)  pwmSetDutyCycle(7, dc)
#define pwm8SetDutyCycle(dc)  pwmSetDutyCycle(8, dc)
#define pwm9SetDutyCycle(dc)  pwmSetDutyCycle(9, dc)

void pwmSetDutyCycle(BYTE chan, WORD dc);
//#define pwmSetDutyCycle(chan,dc)  {if(chan==1) OC1R = dc; else if(chan==2) OC2R = dc; else if .....}  //Alternative method


#define pwm1SetPercent(period, percent)  (OC1R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm2SetPercent(period, percent)  (OC2R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm3SetPercent(period, percent)  (OC3R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm4SetPercent(period, percent)  (OC4R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm5SetPercent(period, percent)  (OC5R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm6SetPercent(period, percent)  (OC6R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm7SetPercent(period, percent)  (OC7R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm8SetPercent(period, percent)  (OC8R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))
#define pwm9SetPercent(period, percent)  (OC9R = ((((period+1)/100) * percent)==0) ? 0 : ((((period+1)/100) * percent)-1))


//#define pwmSetPercent(chan, percent)  {if((chan>0)&&(chan<10)) {regs_oc_[chan-1].OCxR = ((((PWM2_FREQ+1)/100) * percent)==0) ? 0 : ((((PWM2_FREQ+1)/100) * percent)-1);}}
//void pwmSetPercent(BYTE ch, WORD p);

#endif  //#if defined(HAS_NZ_PWM)
#endif