nuttx/boards/mips/pic32mx/ubw32/src/pic32_usbdev.c
Xiang Xiao 977fa987e2 arch/mips: Remove FAR from chip and board folder
Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2022-04-17 18:42:38 +03:00

138 lines
5.4 KiB
C

/****************************************************************************
* boards/mips/pic32mx/ubw32/src/pic32_usbdev.c
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <stdbool.h>
#include <debug.h>
#include <nuttx/usb/usbdev.h>
#include "pic32mx.h"
#include "ubw32.h"
#if defined(CONFIG_PIC32MX_USBDEV)
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: pic32mx_usbdevinitialize
*
* Description:
* Called to configure the mini-A/B J5 on the UBW32 for the
* USB device
*
****************************************************************************/
void weak_function pic32mx_usbdevinitialize(void)
{
/* Notes from the Sure Electronics sample code:
*
* "The USB specifications require that USB peripheral devices must never
* source current onto the Vbus pin. Additionally, USB peripherals should
* not source current on D+ or D- when the host/hub is not actively
* powering the Vbus line.
* When designing a self powered (as opposed to bus powered) USB
* peripheral device, the firmware should make sure not to turn on the
* USB module and D+ or D- pull up resistor unless Vbus is actively
* powered. Therefore, the firmware needs some means to detect when Vbus
* is being powered by the host.
* A 5V tolerant I/O pin can be connected to Vbus (through a resistor),
* and can be used to detect when Vbus is high (host actively powering),
* or low (host is shut down or otherwise not supplying power). The USB
* firmware can then periodically poll this I/O pin to know when it is
* okay to turn on the USB module/D+/D- pull up resistor. When designing
* a purely bus powered peripheral device, it is not possible to source
* current on D+ or D- when the host is not actively providing power on
* Vbus. Therefore, implementing this bus sense feature is optional. ..."
*/
#ifdef CONFIG_USBHOST
#endif
/* "If the host PC sends a GetStatus (device) request, the firmware must
* respond and let the host know if the USB peripheral device is currently
* bus powered or self powered.
* See chapter 9 in the official USB specifications for details
* regarding this request.
* If the peripheral device is capable of being both self and bus powered,
* it should not return a hard coded value for this request.
* Instead, firmware should check if it is currently self or bus powered,
* and respond accordingly.
* If the hardware has been configured like demonstrated on the PICDEM FS
* USB Demo Board, an I/O pin can be polled to determine the
* currently selected power source. ..."
*/
#ifdef CONFIG_USB_PWRSENSE
#endif
}
/****************************************************************************
* Name: pic32mx_usbpullup
*
* Description:
* If USB is supported and the board supports a pullup via GPIO (for USB
* software connect and disconnect), then the board software must provide
* pic32mx_usbpullup. See include/nuttx/usb/usbdev.h for additional
* description of this method. Alternatively, if no pull-up GPIO the
* following EXTERN can be redefined to be NULL.
*
****************************************************************************/
int pic32mx_usbpullup(struct usbdev_s *dev, bool enable)
{
/* The UBW32 does not have a USB pull-up */
return OK;
}
/****************************************************************************
* Name: pic32mx_usbsuspend
*
* Description:
* Board logic must provide the stm32_usbsuspend logic if the USBDEV driver
* is used. This function is called whenever the USB enters or leaves
* suspend mode. This is an opportunity for the board logic to shutdown
* clocks, power, etc. while the USB is suspended.
*
****************************************************************************/
void pic32mx_usbsuspend(struct usbdev_s *dev, bool resume)
{
/* Do nothing */
}
#endif /* CONFIG_PIC32MX_USBDEV */