WiFi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_WiFi__include
#define ti_drivers_WiFi__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#define WiFi_CMD_RESERVED            32

#define WiFi_STATUS_RESERVED        -32

#define WiFi_STATUS_SUCCESS         0

#define WiFi_STATUS_ERROR          -1

#define WiFi_STATUS_UNDEFINEDCMD   -2

/* Add WiFi_CMD_<commands> here */

typedef void (*WiFi_evntCallback) (long eventType, char *data, unsigned char length);

typedef struct WiFi_Config *WiFi_Handle;

typedef struct WiFi_Params {
    uint32_t  bitRate;       
    uint32_t  spawnTaskPri;  
    uintptr_t custom;        
} WiFi_Params;

typedef void (*WiFi_InitFxn) (WiFi_Handle handle);

typedef WiFi_Handle (*WiFi_OpenFxn) (WiFi_Handle handle, unsigned int spiIndex,
                                     WiFi_evntCallback evntCallback,
                                     WiFi_Params *params);

typedef void (*WiFi_CloseFxn) (WiFi_Handle handle);

typedef int  (*WiFi_ControlFxn) (WiFi_Handle handle,
                                 unsigned int cmd,
                                 void *arg);

typedef struct WiFi_FxnTable {
    WiFi_CloseFxn     closeFxn;

    WiFi_ControlFxn   controlFxn;

    WiFi_InitFxn      initFxn;

    WiFi_OpenFxn      openFxn;
} WiFi_FxnTable;

typedef struct WiFi_Config {
    WiFi_FxnTable const   *fxnTablePtr;

    void                  *object;

    void const            *hwAttrs;
} WiFi_Config;

extern void WiFi_close(WiFi_Handle handle);

extern int WiFi_control(WiFi_Handle handle, unsigned int cmd, void *arg);

extern void WiFi_init(void);

extern WiFi_Handle WiFi_open(unsigned int wifiIndex, unsigned int spiIndex,
                             WiFi_evntCallback evntCallback,
                             WiFi_Params *params);

extern void WiFi_Params_init(WiFi_Params *params);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_WiFi__include */