Merge pull request #438 from c1728p9/usb_spec

Initial draft of the HAL USBPhy API

Author: Amanda Butler

docs/reference/contributing/target/usb.md

@@ -1,25 +1,52 @@
-### USB
+### USB device
 
-[Include a brief description here.]
+The HAL USBPhy API provides physical access to the USB bus in the role of a USB device. Implementing this API enables the use of any supported class driver, such as CDC, HID and MSD.
+
+<span class="warnings">**Warning:** We are changing the USB API in an upcoming release of Mbed OS. You can find details on how it may affect you in the [Implementing the USB](#implementing-usb) section.
 
 #### Assumptions
 
 ##### Defined behavior
 
-[Include any defined behavior in bullet format here.]
+- You can use any endpoint configurations that fits in the parameters of the table returned by `USBPhy::endpoint_table`.
+- You can use all endpoints in any valid endpoint configuration concurrently.
+- The device supports use of at least one control, bulk, interrupt and isochronous in each direction at the same time - at least 8 endpoints.
+- USBPhy supports all standard endpoint sizes (wMaxPacketSize).
+- USBPhy can handle an interrupt latency of at least 100ms if the host PC is not performing a reset or setting the device's address.
+- USBPhy only sends USBPhyEvents when it is in the initialized state.
+- When unpowered, USBPhy only sends the `USBPhyEvents::power` event.
+- On USB reset, all endpoints are removed except for endpoint 0.
+- `USBPhyEvents::out` and `USBPhyEvents::in` events only occur for endpoints that you have added.
+- A call to `USBPhy::ep0_write` results in the call of `USBPhyEvents::in` when the PC reads the data unless a power loss or reset occurs first.
+- A call to `endpoint_read` followed by `endpoint_read_result` results in the call of `USBPhyEvents::out` when the PC sends data unless a power loss or reset occurs first.
+- Endpoint 0 naks all transactions aside from setup packets until higher-level code calls one of `USBPhy::ep0_read`, `USBPhy::ep0_write` or `USBPhy::ep0_stall`.
+- Endpoint 0 stall automatically clears on reception of a setup packet.
 
 ##### Undefined behavior
 
-[Include any undefined behavior in bullet format here.]
+- Calling `USBPhy::endpoint_add` or `USBPhy::endpoint_remove` outside of the control requests SetInterface or SetConfiguration.
+- Devices behavior is undefined if latency is greater than 2ms when address is being set - see USB spec 9.2.6.3.
+- Devices behavior is undefined if latency is greater than 10ms when a reset occurs - see USB spec 7.1.7.5.
+- Calling any of the USBPhy::endpoint_* functions on endpoint 0.
 
 ##### Notes
 
-[Include any potential trouble areas in bullet format here.]
+- Make sure USBPhy sends USBPhyEvents in the correct order when multiple packets are present. USBPhy must send IN endpoint events before OUT endpoint events if both are pending.
+- A host PC may resend setup packets to a USB device if there is noise on the USB line. The USBPhy should be able to handle this scenario and respond to the setup packet with an ACK.
+- Bidirectional protocols making use of alternating IN and OUT phases should not rely on the last ACK an IN transfer to indicate that the OUT phase should start. Instead, the OUT phase should be started at the same time the last IN transfer is started. This is because the ACK to the last in transfer may be dropped if there is noise on the USB line. If dropped, it will only be resent on the next IN phase. You can find more information on this in section 8.5.3.3 of the USB specification.
 
 #### Implementing USB
 
-[Include implementation information here.]
+To add support for the HAL USBPhy API, you need to implement this API and submit pull requests against the `feature-hal-spec-usb-device` branch. Please see the API and specification for the HAL USBPhy API for more information:
+
+[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/feature-hal-spec-usb-device-doxy/class_u_s_b_phy.html)
+
+To enable the HAL USBPhy API in Mbed OS, add the `USBDEVICE` label in the `device_has` option of the target's section in the `targets.json` file.
 
 #### Testing
 
-[Include testing information here.]
+The Mbed OS HAL provides a set of conformance tests for the HAL USBPhy API. You can use these tests to validate the correctness of your implementation. To run the HAL USBPhy API tests, use the following command:
+
+```
+mbed test -t <toolchain> -m <target> -n mbed-os-tests-usb_device-*
+```