Developer World
Spresense SDK Library v3.3.0-375c679
cxd56_alt1250.h
1/****************************************************************************
2 * boards/arm/cxd56xx/spresense/include/cxd56_alt1250.h
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership. The
7 * ASF licenses this file to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance with the
9 * License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
16 * License for the specific language governing permissions and limitations
17 * under the License.
18 *
19 ****************************************************************************/
20
21#ifndef __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_CXD56_ALT1250_H
22#define __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_CXD56_ALT1250_H
23
24/****************************************************************************
25 * Included Files
26 ****************************************************************************/
27
28#include <nuttx/config.h>
29
30#ifndef __ASSEMBLY__
31
32/****************************************************************************
33 * Public Data
34 ****************************************************************************/
35
36#undef EXTERN
37#if defined(__cplusplus)
38#define EXTERN extern "C"
39extern "C"
40{
41#else
42#define EXTERN extern
43#endif
44
45/****************************************************************************
46 * Public Function Prototypes
47 ****************************************************************************/
48
49#if defined(CONFIG_MODEM_ALT1250)
50
51/****************************************************************************
52 * Name: board_alt1250_initialize
53 *
54 * Description:
55 * Initialize Altair modem
56 *
57 ****************************************************************************/
58
59int board_alt1250_initialize(const char *devpath);
60
61/****************************************************************************
62 * Name: board_alt1250_uninitialize
63 *
64 * Description:
65 * Uninitialize Altair modem
66 *
67 ****************************************************************************/
68
69int board_alt1250_uninitialize(void);
70
71/****************************************************************************
72 * Name: board_alt1250_poweron
73 *
74 * Description:
75 * Power on the Altair modem device on the board.
76 *
77 ****************************************************************************/
78
79void board_alt1250_poweron(void);
80
81/****************************************************************************
82 * Name: board_alt1250_poweroff
83 *
84 * Description:
85 * Power off the Altair modem device on the board.
86 *
87 ****************************************************************************/
88
89void board_alt1250_poweroff(void);
90
91/****************************************************************************
92 * Name: board_alt1250_powerstatus
93 *
94 * Description:
95 * Get the power status for the Altair modem device on the board.
96 *
97 ****************************************************************************/
98
99bool board_alt1250_powerstatus(void);
100
101/****************************************************************************
102 * Name: board_alt1250_powerkeep
103 *
104 * Description:
105 * Set Modem power keep mode when turning off the board.
106 *
107 ****************************************************************************/
108
109int board_alt1250_powerkeep(bool enable);
110
111/****************************************************************************
112 * Name: board_alt1250_reset
113 *
114 * Description:
115 * Reset the Altair modem device on the board.
116 *
117 ****************************************************************************/
118
119void board_alt1250_reset(void);
120
121#endif
122
123#undef EXTERN
124#if defined(__cplusplus)
125}
126#endif
127
128#endif /* __ASSEMBLY__ */
129#endif /* __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_CXD56_ALT1250_H */