Mistake on this page?
Report an issue in GitHub or email us
whd.h
Go to the documentation of this file.
1 /*
2  * Copyright 2020 Cypress Semiconductor Corporation
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 /** @file whd.h
19  * Provides abstract pointer type to act as instance for: driver, interface, buffer funcs, network funcs, resource funcs and bus funcs.
20  */
21 
22 #include "whd_types.h"
23 
24 #ifndef INCLUDED_WHD_H
25 #define INCLUDED_WHD_H
26 
27 #ifdef __cplusplus
28 extern "C"
29 {
30 #endif
31 
32 /**
33  * Abstract pointer type that acts as a handle to an instance of the driver
34  */
35 typedef struct whd_driver *whd_driver_t;
36 
37 /**
38  * Abstract pointer type to handle instance of whd interface
39  */
41 
42 /**
43  * Abstract type that acts as a handle to an instance of a buffer function
44  */
46 
47 /**
48  * Abstract type that acts as a handle to an instance of a network interface function
49  */
51 
52 /**
53  * Abstract type that acts as a handle to an instance of a resource function
54  */
56 
57 /**
58  * Abstract type that acts as a handle to an instance of a bus function used for SDIO specific functionality
59  */
60 typedef struct whd_bus_funcs whd_sdio_funcs_t;
61 
62 /**
63  * Abstract type that acts as a handle to an instance of a bus function used for SPI specific functionality
64  */
65 typedef struct whd_bus_funcs whd_spi_funcs_t;
66 
67 /**
68  * Structure for storing WHD init configurations
69  */
70 typedef struct whd_init_config
71 {
72  void *thread_stack_start; /**< Pointer to the WHD thread stack */
73  uint32_t thread_stack_size; /**< Size of the WHD thread stack */
74  uint32_t thread_priority; /**< Priority to be set to WHD Thread */
75  whd_country_code_t country; /**< Variable to strore country code information */
77 
78 #ifdef __cplusplus
79 } /* extern "C" */
80 #endif
81 #endif /* INCLUDED_WHD_H */
82 
Contains functions which allows WHD to pass received data to the network stack, to send an ethernet f...
whd_country_code_t
Enumerated list of country codes.
Definition: whd_types.h:434
struct whd_bus_funcs whd_spi_funcs_t
Abstract type that acts as a handle to an instance of a bus function used for SPI specific functional...
Definition: whd.h:65
uint32_t thread_priority
Priority to be set to WHD Thread.
Definition: whd.h:74
void * thread_stack_start
Pointer to the WHD thread stack.
Definition: whd.h:72
struct whd_init_config whd_init_config_t
Structure for storing WHD init configurations.
whd_country_code_t country
Variable to strore country code information.
Definition: whd.h:75
Defines common data types used with WHD.
struct whd_driver * whd_driver_t
Abstract pointer type that acts as a handle to an instance of the driver.
Definition: whd.h:35
struct whd_interface * whd_interface_t
Abstract pointer type to handle instance of whd interface.
Definition: whd.h:40
Structure for storing WHD init configurations.
Definition: whd.h:70
struct whd_bus_funcs whd_sdio_funcs_t
Abstract type that acts as a handle to an instance of a bus function used for SDIO specific functiona...
Definition: whd.h:60
Allows WHD to perform buffer related operations like, allocating, releasing, retrieving the current p...
uint32_t thread_stack_size
Size of the WHD thread stack.
Definition: whd.h:73
Interface to a data source that provides external resources to the radio driver.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.