Fork us on GitHub Follow us on Facebook Follow us on Twitter

Changeset 23f40280 in mainline


Ignore:
Timestamp:
2011-05-08T20:43:00Z (11 years ago)
Author:
Jan Vesely <jano.vesely@…>
Branches:
lfn, master
Children:
7e7b791
Parents:
511cfc8
Message:

Doxygen and other minor fixes (no functional change)

Location:
uspace/drv
Files:
20 edited

Legend:

Unmodified
Added
Removed
  • uspace/drv/ohci/batch.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 /** @addtogroup drvusbuhcihc
     28/** @addtogroup drvusbohci
    2929 * @{
    3030 */
    3131/** @file
    32  * @brief UHCI driver USB transaction structure
     32 * @brief OHCI driver USB transaction structure
    3333 */
    34 #ifndef DRV_UHCI_BATCH_H
    35 #define DRV_UHCI_BATCH_H
     34#ifndef DRV_OHCI_BATCH_H
     35#define DRV_OHCI_BATCH_H
    3636
    3737#include <usbhc_iface.h>
  • uspace/drv/ohci/endpoint_list.h

    r511cfc8 r23f40280  
    4141#include "utils/malloc32.h"
    4242
    43 typedef struct endpoint_list
    44 {
     43typedef struct endpoint_list {
    4544        fibril_mutex_t guard;
    4645        ed_t *list_head;
  • uspace/drv/ohci/iface.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 
    2928/** @addtogroup drvusbohci
    3029 * @{
  • uspace/drv/ohci/ohci.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 
    2928/** @addtogroup drvusbohci
    3029 * @{
  • uspace/drv/ohci/ohci_regs.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 
    2928/** @addtogroup drvusbohcihc
    3029 * @{
  • uspace/drv/ohci/pci.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 
    2928/** @addtogroup drvusbohci
    3029 * @{
  • uspace/drv/ohci/root_hub.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 
    2928/** @addtogroup drvusbohci
    3029 * @{
  • uspace/drv/ohci/utils/malloc32.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 /** @addtogroup usb
     28/** @addtogroup drvusbohci
    2929 * @{
    3030 */
    3131/** @file
    32  * @brief UHCI driver
     32 * @brief OHCI driver
    3333 */
    34 #ifndef DRV_UHCI_TRANSLATOR_H
    35 #define DRV_UHCI_TRANSLATOR_H
     34#ifndef DRV_OHCI_UTILS_MALLOC32_H
     35#define DRV_OHCI_UTILS_MALLOC32_H
    3636
    3737#include <assert.h>
     
    4040#include <mem.h>
    4141#include <as.h>
    42 
    43 #define UHCI_REQUIRED_PAGE_SIZE 4096
    4442
    4543/** Get physical address translation
     
    6159 *
    6260 * @param[in] size Size of the required memory space
    63  * @return Address of the alligned and big enough memory place, NULL on failure.
     61 * @return Address of the aligned and big enough memory place, NULL on failure.
    6462 */
    6563static inline void * malloc32(size_t size)
     
    7270static inline void free32(void *addr)
    7371        { if (addr) free(addr); }
    74 /*----------------------------------------------------------------------------*/
    75 /** Create 4KB page mapping
    76  *
    77  * @return Address of the mapped page, NULL on failure.
    78  */
    79 static inline void * get_page(void)
    80 {
    81         void * free_address = as_get_mappable_page(UHCI_REQUIRED_PAGE_SIZE);
    82         assert(free_address);
    83         if (free_address == 0)
    84                 return NULL;
    85         void* ret =
    86           as_area_create(free_address, UHCI_REQUIRED_PAGE_SIZE,
    87                   AS_AREA_READ | AS_AREA_WRITE);
    88         if (ret != free_address)
    89                 return NULL;
    90         return ret;
    91 }
    92 
    9372#endif
    9473/**
  • uspace/drv/uhci-hcd/batch.c

    r511cfc8 r23f40280  
    7070 * @param[in] ep Communication target
    7171 * @param[in] buffer Data source/destination.
    72  * @param[in] size Size of the buffer.
     72 * @param[in] buffer_size Size of the buffer.
    7373 * @param[in] setup_buffer Setup data source (if not NULL)
    7474 * @param[in] setup_size Size of setup_buffer (should be always 8)
  • uspace/drv/uhci-hcd/hc.c

    r511cfc8 r23f40280  
    6161 * @param[in] instance Memory place to initialize.
    6262 * @param[in] regs Address of I/O control registers.
    63  * @param[in] size Size of I/O control registers.
     63 * @param[in] reg_size Size of I/O control registers.
     64 * @param[in] interrupts True if hw interrupts should be used.
    6465 * @return Error code.
    6566 * @note Should be called only once on any structure.
  • uspace/drv/uhci-hcd/hc.h

    r511cfc8 r23f40280  
    3333 * @brief UHCI host controller driver structure
    3434 */
    35 #ifndef DRV_UHCI_UHCI_HC_H
    36 #define DRV_UHCI_UHCI_HC_H
     35#ifndef DRV_UHCI_HC_H
     36#define DRV_UHCI_HC_H
    3737
    3838#include <fibril.h>
  • uspace/drv/uhci-hcd/hw_struct/link_pointer.h

    r511cfc8 r23f40280  
    3232 * @brief UHCI driver
    3333 */
    34 #ifndef DRV_UHCI_LINK_POINTER_H
    35 #define DRV_UHCI_LINK_POINTER_H
     34#ifndef DRV_UHCI_HW_STRUCT_LINK_POINTER_H
     35#define DRV_UHCI_HW_STRUCT_LINK_POINTER_H
    3636
    3737/* UHCI link pointer, used by many data structures */
  • uspace/drv/uhci-hcd/hw_struct/queue_head.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 /** @addtogroup drv usbuhcihc
     28/** @addtogroup drvusbuhcihc
    2929 * @{
    3030 */
     
    3232 * @brief UHCI driver
    3333 */
    34 #ifndef DRV_UHCI_QH_H
    35 #define DRV_UHCI_QH_H
     34#ifndef DRV_UHCI_HW_STRUCT_QH_H
     35#define DRV_UHCI_HW_STRUCT_QH_H
    3636#include <assert.h>
    3737
     
    6565 *
    6666 * @param[in] instance qh_t structure to use.
    67  * @param[in] pa Physical address of the next queue head.
     67 * @param[in] next Address of the next queue.
    6868 *
    6969 * Adds proper flag. If the pointer is NULL, sets next to terminal NULL.
     
    8181/** Set queue head element pointer
    8282 *
    83  * @param[in] instance qh_t structure to initialize.
    84  * @param[in] pa Physical address of the TD structure.
     83 * @param[in] instance qh_t structure to use.
     84 * @param[in] td Transfer descriptor to set as the first element.
    8585 *
    8686 * Adds proper flag. If the pointer is NULL, sets element to terminal NULL.
  • uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h

    r511cfc8 r23f40280  
    3232 * @brief UHCI driver
    3333 */
    34 #ifndef DRV_UHCI_TRANSFER_DESCRIPTOR_H
    35 #define DRV_UHCI_TRANSFER_DESCRIPTOR_H
     34#ifndef DRV_UHCI_HW_STRUCT_TRANSFER_DESCRIPTOR_H
     35#define DRV_UHCI_HW_STRUCT_TRANSFER_DESCRIPTOR_H
    3636
    3737#include <mem.h>
  • uspace/drv/uhci-hcd/root_hub.h

    r511cfc8 r23f40280  
    3333 * @brief UHCI driver
    3434 */
    35 #ifndef DRV_UHCI_UHCI_RH_H
    36 #define DRV_UHCI_UHCI_RH_H
     35#ifndef DRV_UHCI_RH_H
     36#define DRV_UHCI_RH_H
    3737
    3838#include <ddf/driver.h>
  • uspace/drv/uhci-hcd/uhci.c

    r511cfc8 r23f40280  
    161161/** Initialize hc and rh DDF structures and their respective drivers.
    162162 *
    163  * @param[in] instance UHCI structure to use.
    164163 * @param[in] device DDF instance of the device to use.
    165164 *
     
    167166 *  - gets device's hw resources
    168167 *  - disables UHCI legacy support (PCI config space)
    169  *  - asks for interrupt
     168 *  - attempts to enable interrupts
    170169 *  - registers interrupt handler
    171170 */
  • uspace/drv/uhci-hcd/utils/malloc32.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 /** @addtogroup usb
     28/** @addtogroup drvusbuhci
    2929 * @{
    3030 */
     
    3232 * @brief UHCI driver
    3333 */
    34 #ifndef DRV_UHCI_TRANSLATOR_H
    35 #define DRV_UHCI_TRANSLATOR_H
     34#ifndef DRV_UHCI_UTILS_MALLOC32_H
     35#define DRV_UHCI_UTILS_MALLOC32_H
    3636
    3737#include <assert.h>
  • uspace/drv/uhci-hcd/utils/slab.c

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 /** @addtogroup usb
     28/** @addtogroup drvusbuhcihc
    2929 * @{
    3030 */
  • uspace/drv/uhci-hcd/utils/slab.h

    r511cfc8 r23f40280  
    2626 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    2727 */
    28 /** @addtogroup usb
     28/** @addtogroup drvusbuhcihc
    2929 * @{
    3030 */
     
    3232 * @brief UHCI driver
    3333 */
    34 #ifndef DRV_UHCI_SLAB_H
    35 #define DRV_UHCI_SLAB_H
     34#ifndef DRV_UHCI_UTILS_SLAB_H
     35#define DRV_UHCI_UTILS_SLAB_H
    3636
    3737#include <bool.h>
  • uspace/drv/uhci-rhd/port.c

    r511cfc8 r23f40280  
    6565 *
    6666 * @param[in] port Structure to use.
    67  * @param[in] value New register value.
     67 * @param[in] val New register value.
    6868 * @return Error code. (Always EOK)
    6969 */
     
    7777 *
    7878 * @param[in] port Memory structure to use.
    79  * @param[in] addr Address of I/O register.
     79 * @param[in] address Address of I/O register.
    8080 * @param[in] number Port number.
    8181 * @param[in] usec Polling interval.
Note: See TracChangeset for help on using the changeset viewer.