hal/nrf24lu1p/hal_usb.h

Go to the documentation of this file.

/* Copyright (c) 2009 Nordic Semiconductor. All Rights Reserved.
 *
 * The information contained herein is confidential property of Nordic 
 * Semiconductor ASA.Terms and conditions of usage are described in detail 
 * in NORDIC SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. 
 *
 * Licensees are granted free, non-transferable use of the information. NO
 * WARRENTY of ANY KIND is provided. This heading must NOT be removed from
 * the file.
 *              
 * $LastChangedRevision: 2378 $
 */

#ifndef HAL_USB_H__
#define HAL_USB_H__

#include <stdint.h>
#include <stdbool.h>

#include "hal_usb_desc.h"
#include "config.h" 

#ifndef USB_DESC_TEMPLATE
#error "USB_DESC_TEMPLATE not defined. Please include a file with g_usb_string_desc, g_usb_conf_desc and g_usb_dev_desc defined" 
#endif

#define USB_BM_STATE_CONFIGURED 0x01
#define USB_BM_STATE_ALLOW_REMOTE_WAKEUP 0x02
#define USB_BM_STATE_HOST_WU     0x04

typedef enum  { 
    ATTACHED,   
    POWERED,    
    DEFAULT,    
    ADDRESSED,  
    CONFIGURED, 
    SUSPENDED   
} hal_usb_state_t;

typedef struct {
    uint8_t  bmRequestType; 
    uint8_t  bRequest;       
    uint8_t wValueMsb;      
    uint8_t wValueLsb;      
    uint8_t wIndex;         
    uint8_t wLength;        
//    void* misc_data;
} hal_usb_device_req;

typedef enum {
    STALL,         
    NAK,           
    ACK,           
    NO_RESPONSE,   
    DATA,          
    EMPTY_RESPONSE 
} hal_usb_dev_req_resp_t;

typedef hal_usb_dev_req_resp_t (*hal_usb_cb_device_req_t)(hal_usb_device_req* device_req, uint8_t ** data_ptr, uint8_t* size) large reentrant;

typedef uint8_t (*hal_usb_cb_endpoint_t)(uint8_t* adr_ptr, uint8_t* size) large reentrant;

typedef void (*hal_usb_cb_resume_t)() large reentrant;

typedef void (*hal_usb_cb_suspend_t)(uint8_t allow_remote_wu) large reentrant;

typedef void (*hal_usb_cb_reset_t)() large reentrant;

typedef struct {
    usb_descs_templ_t descs;     
    uint8_t  bm_state;             
    uint8_t current_config;        
    uint8_t current_alt_interface; 
    hal_usb_state_t state;       
    hal_usb_cb_device_req_t device_req;
    hal_usb_cb_reset_t      reset;
    hal_usb_cb_resume_t     resume;
    hal_usb_cb_suspend_t    suspend;
} hal_usb_t;

void hal_usb_init(
    bool usb_disconnect,
    hal_usb_cb_device_req_t device_req,
    hal_usb_cb_reset_t      reset,
    hal_usb_cb_resume_t     resume,
    hal_usb_cb_suspend_t    suspend);

void hal_usb_send_data(uint8_t ep_in_num, uint8_t* buffer, uint8_t bytes_to_send);

void hal_usb_endpoint_config(uint8_t ep_num, uint8_t ep_size, hal_usb_cb_endpoint_t endpoint_isr);

void hal_usb_endpoint_stall(uint8_t ep_num, bool stall);

hal_usb_state_t hal_usb_get_state();

uint8_t hal_usb_get_address();

void hal_usb_wakeup();

void hal_usb_reset();

void hal_usb_bus_disconnect();

void hal_usb_bus_connect();

void hal_usb_sleep();

extern hal_usb_t volatile g_hal_usb;

#endif //  HAL_USB_H__