SFBHWPWM.h

Go to the documentation of this file.

/*                                              -*- mode:C++; fill-column:100 -*-
  SFBHWPWM.h - Support for h/w-based Pulse Width Modulation
  Copyright (C) 2009 The Regents of the University of New Mexico.  All rights reserved.

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

  This library 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
  Lesser General Public License for more details.

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

#ifndef SFBHWPWM_H_
#define SFBHWPWM_H_

#include "SFBTypes.h"

void PWMStart();

void PWMStop();

enum PWMChannelModes {
  PWM_INACTIVE,                 
  PWM_SINGLE_EDGE,              
  PWM_DOUBLE_EDGE,              
  PWM_CHANNEL_MODES_MAX
};

void PWMSetMode(u32 pwmIndex, u32 mode);

void PWMSetWidth(u32 pwmIndex, u32 width, bool commit = true);

u32 PWMGetWidth(u32 pwmIndex);


int PWMFindIndex(int sfbPin);

u32 PWMGetPin(u32 pwmIndex);

u32 PWMGetChannel(u32 pwmIndex);

enum PWMIndices {
  PWM_BODY_RGB_RED_PIN,         
  PWM_BODY_RGB_GREEN_PIN,       
  PWM_BODY_RGB_BLUE_PIN,        
  PWM_NORTH_LED_PIN,            
  PWM_SOUTH_LED_PIN,            
  PWM_EAST_LED_PIN,             
  PWM_WEST_D0_PIN,              
  PWM_WEST_D2_PIN,              
  PWM_WEST_D3_PIN,              
  PWM_EAST_D1_PIN,              
  PWM_EAST_D3_PIN               
};

#endif /*SFBHWPWM_H_*/