/******************************************************************************
USB Hardware Abstraction Layer (HAL)
Summary:
This file abstracts the hardware interface. The USB stack firmware can be
compiled to work on different USB microcontrollers, such as PIC18 and PIC24.
The USB related special function registers and bit names are generally very
similar between the device families, but small differences in naming exist.
Description:
This file abstracts the hardware interface. The USB stack firmware can be
compiled to work on different USB microcontrollers, such as PIC18 and PIC24.
The USB related special function registers and bit names are generally very
similar between the device families, but small differences in naming exist.
In order to make the same set of firmware work accross the device families,
when modifying SFR contents, a slightly abstracted name is used, which is
then "mapped" to the appropriate real name in the usb_hal_picxx.h header.
Make sure to include the correct version of the usb_hal_picxx.h file for
the microcontroller family which will be used.
This file is located in the "\<Install Directory\>\\Microchip\\Include\\USB"
directory.
When including this file in a new project, this file can either be
referenced from the directory in which it was installed or copied
directly into the user application folder. If the first method is
chosen to keep the file located in the folder in which it is installed
then include paths need to be added so that the library and the
application both know where to reference each others files. If the
application folder is located in the same folder as the Microchip
folder (like the current demo folders), then the following include
paths need to be added to the application's project:
.
..\\..\\MicrochipInclude
If a different directory structure is used, modify the paths as
required. An example using absolute paths instead of relative paths
would be the following:
C:\\Microchip Solutions\\Microchip\\Include
C:\\Microchip Solutions\\My Demo Application
*******************************************************************************/
//DOM-IGNORE-BEGIN
/******************************************************************************
File Description:
This file defines the interface to the USB hardware abstraction layer.
Filename: usb_hal_pic24.c
Dependancies: none
Processor: PIC24F USB Microcontrollers
Hardware: PIC24F USB Microcontrollers
Compiler: Microchip C30 (for PIC24)
Company: Microchip Technology, Inc.
Software License Agreement:
The software supplied herewith by Microchip Technology Incorporated
(the Company) for its PICmicro® Microcontroller is intended and
supplied to you, the Companys customer, for use solely and
exclusively on Microchip PICmicro Microcontroller products. The
software is owned by the Company and/or its supplier, and is
protected under applicable copyright laws. All rights are reserved.
Any use in violation of the foregoing restrictions may subject the
user to criminal sanctions under applicable laws, as well as to
civil liability for the breach of the terms and conditions of this
license.
THIS SOFTWARE IS PROVIDED IN AN AS IS CONDITION. NO WARRANTIES,
WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED
TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,
IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
*************************************************************************/
//DOM-IGNORE-BEGIN
/********************************************************************
Change History:
Rev Description
---- -----------
2.7 Created USBSleepOnSuspend() function to simply process of putting
the PIC24F device in the correct state before issuing the sleep
instruction and returning the device to the correct state after
exiting sleep.
2.7a Fixed issue where the USBSleepOnSuspend() function would cause
the USB communication to fail after being called when _IPL
is equal to 0.
********************************************************************/
//DOM-IGNORE-END
#ifndef USB_HAL_PIC24F_C
#define USB_HAL_PIC24F_C
#include "USB\usb.h"
/*************************************************************************
Function:
BOOL USBSleepOnSuspend(void)
Summary:
Places the PIC24F devices in sleep after enabling the USB activity flag to
wake it back up.
Conditions:
IPL (in the SR register) must be non-zero.
Input:
None
Return:
TRUE - if entered sleep successfully
FALSE - if there was an error entering sleep
Remarks:
None
*************************************************************************/
BOOL USBSleepOnSuspend(void)
{
unsigned int U1EIE_save, U1IE_save, U1OTGIE_save;
unsigned char USB1IE_save;
#if defined(USB_POLLING)
//If IPL is equal to 0 then there is no way for the USB module to
// generate an interrupt to wake up the device.
if(_IPL == 0)
{
return FALSE;
}
//Set the interrupt priority to a level that will wake up the part (>0)
// but will not cause a interrupt vector jump (USB1IP<=IPL)
_USB1IP = 1;
#endif
//Save the old interrupt and CPU settings
U1EIE_save = U1EIE;
U1IE_save = U1IE;
U1OTGIE_save = U1OTGIE;
USB1IE_save = IEC5bits.USB1IE;
//Disable all USB interrupts
U1EIE = 0;
U1IE = 0;
U1OTGIE = 0;
//Enable the interrupt
IFS5bits.USB1IF = 0;
U1OTGIEbits.ACTVIE = 1;
USBClearInterruptFlag(USBActivityIFReg,USBActivityIFBitNum);
IEC5bits.USB1IE = 1;
Sleep();
#if defined(USB_POLLING)
//Disable the interrupt
_USB1IP = 0;
#endif
//restore the previous interrupt settings
IEC5bits.USB1IE = USB1IE_save;
U1EIE = U1EIE_save;
U1IE = U1IE_save;
U1OTGIE = U1OTGIE_save;
return TRUE;
}
#endif //USB_HAL_PIC24F_C
|