Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
whd_bus_common.h
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 #include "whd.h"
18 #include <stdint.h>
19 
20 #ifndef INCLUDED_WHD_BUS_COMMON_H
21 #define INCLUDED_WHD_BUS_COMMON_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 struct whd_bus_common_info;
28 
29 void whd_bus_common_info_init(whd_driver_t whd_driver);
30 void whd_bus_common_info_deinit(whd_driver_t whd_driver);
31 
32 /* Configure delayed sleep of bus.
33  * A high number will mean a longer delay before sleep after the last operation (higher performance)
34  * A shorter delay will mean quicker sleep after last operation (lower power use)
35  */
36 extern void whd_bus_sdio_wlan_set_delayed_bus_powersave_milliseconds(whd_driver_t whd_driver, uint32_t time_ms);
37 extern whd_result_t whd_bus_resume_after_deep_sleep(whd_driver_t whd_driver);
38 
39 extern whd_result_t whd_bus_write_wifi_firmware_image(whd_driver_t whd_driver);
40 extern whd_result_t whd_bus_write_wifi_nvram_image(whd_driver_t whd_driver);
41 extern void whd_bus_set_resource_download_halt(whd_driver_t whd_driver, whd_bool_t halt);
42 
43 extern whd_result_t whd_bus_transfer_backplane_bytes(whd_driver_t whd_driver, whd_bus_transfer_direction_t direction,
44  uint32_t address, uint32_t size, uint8_t *data);
45 extern void whd_bus_init_backplane_window(whd_driver_t whd_driver);
46 whd_result_t whd_bus_set_backplane_window(whd_driver_t whd_driver, uint32_t addr);
47 
48 whd_bool_t whd_bus_is_up(whd_driver_t whd_driver);
49 extern whd_result_t whd_bus_set_flow_control(whd_driver_t whd_driver, uint8_t value);
50 extern whd_bool_t whd_bus_is_flow_controlled(whd_driver_t whd_driver);
51 
52 void whd_bus_set_state(whd_driver_t whd_driver, whd_bool_t state);
53 
54 extern void whd_delayed_bus_release_schedule_update(whd_driver_t whd_driver, whd_bool_t is_scheduled);
55 
56 /* handle delayed sleep of bus */
57 extern uint32_t whd_bus_handle_delayed_release(whd_driver_t whd_driver);
58 whd_bool_t whd_bus_platform_mcu_power_save_deep_sleep_enabled(whd_driver_t whd_driver);
59 
60 #ifdef __cplusplus
61 } /*extern "C" */
62 #endif
63 
64 #endif
65 
whd.h
Provides abstract pointer type to act as instance for: driver, interface, buffer funcs, network funcs, resource funcs and bus funcs.
whd_bus_transfer_direction_t
whd_bus_transfer_direction_t
Transfer direction for the WHD platform bus interface.
Definition: whd_types.h:172
whd_driver
Definition: whd_int.h:72
whd_bool_t
whd_bool_t
Boolean values.
Definition: whd_types.h:162
whd_result_t
uint32_t whd_result_t
WHD result is specified as uint32_t value.
Definition: whd_types.h:776
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.