Diff: USBHost/USBHALHost.h

Revision:

8:93da8ea2708b

Parent:

4:b320d68e98e7

Child:

24:868cbfe611a7

--- a/USBHost/USBHALHost.h	Wed Mar 13 17:30:42 2013 +0000
+++ b/USBHost/USBHALHost.h	Thu Mar 14 11:49:53 2013 +0000
@@ -1,20 +1,18 @@
-/* Copyright (c) 2010-2012 mbed.org, MIT License
-*
-* Permission is hereby granted, free of charge, to any person obtaining a copy of this software
-* and associated documentation files (the "Software"), to deal in the Software without
-* restriction, including without limitation the rights to use, copy, modify, merge, publish,
-* distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
-* Software is furnished to do so, subject to the following conditions:
-*
-* The above copyright notice and this permission notice shall be included in all copies or
-* substantial portions of the Software.
-*
-* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-* BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-*/
+/* mbed USBHost Library
+ * Copyright (c) 2006-2013 ARM Limited
+ *
+ * Licensed 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.
+ */
 
 #ifndef USBHALHOST_H
 #define USBHALHOST_H
@@ -24,8 +22,11 @@
 
 class USBHostHub;
 
+/**
+* USBHALHost class
+*/
 class USBHALHost {
-public:
+protected:
 
     /**
     * Constructor
@@ -65,7 +66,6 @@
     */
     uint32_t interruptHeadED();
     
-    
     /**
     * Update the head ED for control transfers
     */
@@ -81,17 +81,20 @@
     */
     void updateInterruptHeadED(uint32_t addr);
     
-    /* *
+    /**
     * Enable List for the specified endpoint type
+    *
+    * @param type enable the list of ENDPOINT_TYPE type
     */
     void enableList(ENDPOINT_TYPE type);
     
     /**
     * Disable List for the specified endpoint type
+    *
+    * @param type disable the list of ENDPOINT_TYPE type
     */
     bool disableList(ENDPOINT_TYPE type);
 
-protected:
     /**
     * Virtual method called when a device has been connected
     *
@@ -100,7 +103,7 @@
     * @param lowSpeed 1 if low speed, 0 otherwise
     * @param hub_parent reference to the hub where the device is connected (NULL if the hub parent is the root hub)
     */
-    virtual void deviceConnected(int hub, int port, bool lowSpeed, USBHostHub * hub_parent = NULL) {};
+    virtual void deviceConnected(int hub, int port, bool lowSpeed, USBHostHub * hub_parent = NULL) = 0;
     
     /**
     * Virtual method called when a device has been disconnected
@@ -110,26 +113,26 @@
     * @param hub_parent reference to the hub where the device is connected (NULL if the hub parent is the root hub)
     * @param addr list of the TDs which have been completed to dequeue freed TDs
     */
-    virtual void deviceDisconnected(int hub, int port, USBHostHub * hub_parent, volatile uint32_t addr) {};
+    virtual void deviceDisconnected(int hub, int port, USBHostHub * hub_parent, volatile uint32_t addr) = 0;
     
     /**
     * Virtual method called when a transfer has been completed
     *
     * @param addr list of the TDs which have been completed
     */
-    virtual void transferCompleted(volatile uint32_t addr){};
+    virtual void transferCompleted(volatile uint32_t addr) = 0;
     
     /**
     * Find a memory section for a new ED
     *
-    * @returns the address of this section
+    * @returns the address of the new ED
     */
     volatile uint8_t * getED();
     
     /**
     * Find a memory section for a new TD
     *
-    * @returns the address of this section
+    * @returns the address of the new TD
     */
     volatile uint8_t * getTD();