202 lines
8.3 KiB
C
202 lines
8.3 KiB
C
/*
|
|
*********************************************************************************************************
|
|
* uC/USB-Host
|
|
* The Embedded USB Host Stack
|
|
*
|
|
* Copyright 2004-2021 Silicon Laboratories Inc. www.silabs.com
|
|
*
|
|
* SPDX-License-Identifier: APACHE-2.0
|
|
*
|
|
* This software is subject to an open source license and is distributed by
|
|
* Silicon Laboratories Inc. pursuant to the terms of the Apache License,
|
|
* Version 2.0 available at www.apache.org/licenses/LICENSE-2.0.
|
|
*
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
*
|
|
* USB HOST CLASS OPERATIONS
|
|
*
|
|
* Filename : usbh_class.h
|
|
* Version : V3.42.01
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* MODULE
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#ifndef USBH_CLASS_MODULE_PRESENT
|
|
#define USBH_CLASS_MODULE_PRESENT
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* INCLUDE FILES
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#include "usbh_core.h"
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* EXTERNS
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#ifdef USBH_CLASS_MODULE
|
|
#define USBH_CLASS_EXT
|
|
#else
|
|
#define USBH_CLASS_EXT extern
|
|
#endif
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* DEFINES
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CLASS DEVICE STATE
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#define USBH_CLASS_DEV_STATE_NONE 0u
|
|
#define USBH_CLASS_DEV_STATE_CONN 1u
|
|
#define USBH_CLASS_DEV_STATE_DISCONN 2u
|
|
#define USBH_CLASS_DEV_STATE_SUSPEND 3u
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CLASS DRIVER TYPE
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#define USBH_CLASS_DRV_TYPE_NONE 0u
|
|
#define USBH_CLASS_DRV_TYPE_IF_CLASS_DRV 1u
|
|
#define USBH_CLASS_DRV_TYPE_DEV_CLASS_DRV 2u
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* DATA TYPES
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CLASS DRIVER API DATA TYPE
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
struct usbh_class_drv {
|
|
CPU_INT08U *NamePtr; /* Name of the class driver. */
|
|
|
|
void (*GlobalInit) (USBH_ERR *p_err); /* Global initialization function. */
|
|
|
|
void *(*ProbeDev ) (USBH_DEV *p_dev, /* Probe device descriptor. */
|
|
USBH_ERR *p_err);
|
|
|
|
void *(*ProbeIF ) (USBH_DEV *p_dev, /* Probe interface descriptor. */
|
|
USBH_IF *p_if,
|
|
USBH_ERR *p_err);
|
|
|
|
void (*Suspend ) (void *p_class_dev); /* Called when bus suspends. */
|
|
|
|
void (*Resume ) (void *p_class_dev); /* Called when bus resumes. */
|
|
|
|
void (*Disconn ) (void *p_class_dev); /* Called when device is removed. */
|
|
};
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CLASS DRIVER NOTIFICATION DATA TYPE
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
typedef void (*USBH_CLASS_NOTIFY_FNCT)(void *p_class_dev,
|
|
CPU_INT08U is_conn,
|
|
void *p_ctx);
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CLASS DRIVER REGISTRATION DATA TYPE
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
struct usbh_class_drv_reg {
|
|
USBH_CLASS_DRV *ClassDrvPtr; /* Class driver structure */
|
|
USBH_CLASS_NOTIFY_FNCT NotifyFnctPtr; /* Called when device connection status changes */
|
|
void *NotifyArgPtr; /* Context of the notification funtion */
|
|
CPU_INT08U InUse;
|
|
};
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* GLOBAL VARIABLES
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* REGISTERED USB CLASS DRIVERS LIST
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
USBH_CLASS_EXT USBH_CLASS_DRV_REG USBH_ClassDrvList[USBH_CFG_MAX_NBR_CLASS_DRVS];
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* MACROS
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* FUNCTION PROTOTYPES
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
USBH_ERR USBH_ClassDrvReg (USBH_CLASS_DRV *p_class_drv,
|
|
USBH_CLASS_NOTIFY_FNCT class_notify_fnct,
|
|
void *p_class_notify_ctx);
|
|
|
|
USBH_ERR USBH_ClassDrvUnreg (USBH_CLASS_DRV *p_class_drv);
|
|
|
|
void USBH_ClassSuspend (USBH_DEV *p_dev);
|
|
|
|
void USBH_ClassResume (USBH_DEV *p_dev);
|
|
|
|
USBH_ERR USBH_ClassDrvConn (USBH_DEV *p_dev);
|
|
|
|
void USBH_ClassDrvDisconn(USBH_DEV *p_dev);
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* CONFIGURATION ERRORS
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
|
|
/*
|
|
*********************************************************************************************************
|
|
* MODULE END
|
|
*********************************************************************************************************
|
|
*/
|
|
|
|
#endif
|