summaryrefslogtreecommitdiffstats
path: root/reference-cne/src/CRefCneRadio.cpp
blob: f724bceb68815c208f54eb7368fc22a6f98cd53a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
/*============================================================================
  FILE:         CRefCneRadio.cpp

  OVERVIEW:     The CRefCneRadio class provides means to control an air
                interface upon creation of its object. Some of the methods
                such as bIsDataConnected, bIsConStateChanged, provide means to
                find out the current connectivity state of the radio

  DEPENDENCIES: The CRefCneRadio class is constructed for a unique air interface
                denoted by its RAT type. Once constructed, all other methods
                can be called on this object.
============================================================================*/

/* Copyright (c) 2010, Code Aurora Forum. 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 Code Aurora 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, FITNESS FOR A PARTICULAR PURPOSE AND
 * NON-INFRINGEMENT 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.
 *
 */


/*---------------------------------------------------------------------------
 * Extern Declarations
 *-------------------------------------------------------------------------*/
extern "C" void cne_sendUnsolicitedMsg
  (
  int targetFd,
  int msgType,
  int dataLen,
  void *data
  );

/*----------------------------------------------------------------------------
 * Includes
 * -------------------------------------------------------------------------*/
#include "CRefCneRadio.h"
#include "RefCneDefs.h"
#include "cne.h"

/*=============================================================================
  FUNCTION      CRefCneRadio

  DESCRIPTION   Class constructor initializes class member variables

  DEPENDENCIES  None

  RETURN VALUE  CRefCneRadio instance

  SIDE EFFECTS  None
 ============================================================================*/
CRefCneRadio::CRefCneRadio
(
  cne_rat_type myRadio
):m_iRequestState(REF_CNE_NET_NOT_PENDING),
  m_iNetConState(REF_CNE_NET_STATE_UNINITIALIZED),
  m_iPrevNetConState(REF_CNE_NET_STATE_UNINITIALIZED)
{
  RCNE_MSG_DEBUG("In RefCneRadio constructor");
  /* set the command handlers */

  m_iMyRatType = myRadio;

  RCNE_MSG_DEBUG("RefCneRadio constructed for RAT: %d",m_iMyRatType);
}
/*=============================================================================
  FUNCTION      CRefCneRadio

  DESCRIPTION   Copy constructor, not allowed.

  DEPENDENCIES  None

  RETURN VALUE  None

  SIDE EFFECTS  None
 ============================================================================*/
CRefCneRadio::CRefCneRadio(const CRefCneRadio& radio)
{
}
/*=============================================================================
  FUNCTION      bIsDataConnected

  DESCRIPTION   Querrys the Radio to see if it is connected

  DEPENDENCIES  None

  RETURN VALUE  TRUE, FALSE

  SIDE EFFECTS  None
 ============================================================================*/
bool CRefCneRadio::bIsDataConnected ()
{
  if(m_iNetConState == REF_CNE_NET_STATE_CONNECTED)
  {
    return TRUE;
  }
  else
  {
    return FALSE;
  }
}
/*=============================================================================
  FUNCTION      iIsConActionPending

  DESCRIPTION   Querrys the Radio for a pending request

  DEPENDENCIES  None

  RETURN VALUE  TRUE, FALSE

  SIDE EFFECTS  None
 ============================================================================*/
int CRefCneRadio::iIsConActionPending
(
)
{
  return m_iRequestState;
}
/*=============================================================================
  FUNCTION      ClearPending

  DESCRIPTION   Clears the request pending flag

  DEPENDENCIES  None

  RETURN VALUE  None

  SIDE EFFECTS  None
 ============================================================================*/
void CRefCneRadio::ClearPending
(
)
{
  RCNE_MSG_DEBUG("CP: cleared network [%d] request status",m_iMyRatType);
  m_iRequestState = REF_CNE_NET_NOT_PENDING;
}
/*=============================================================================
  FUNCTION      bIsConStateChanged

  DESCRIPTION   Querry the radio to see if the new status is different from
                previous

  DEPENDENCIES  None

  RETURN VALUE  None

  SIDE EFFECTS  None
 ============================================================================*/
bool CRefCneRadio::bIsConStateChanged
(
)
{
  if(m_iNetConState != m_iPrevNetConState)
  {
    return TRUE;
  }
  else
  {
    return FALSE;
  }
}
/*=============================================================================
  FUNCTION      UpdateStatus

  DESCRIPTION   Maintains the previous and current state of the radio

  DEPENDENCIES  None

  RETURN VALUE  None

  SIDE EFFECTS  None
 ============================================================================*/
void CRefCneRadio::UpdateStatus
  (
  int myNetStatus
  )
{
  m_iNetState = (cne_network_state_enum_type )myNetStatus;
  m_iPrevNetConState = m_iNetConState;
  switch(myNetStatus)
  {
    case CNE_NETWORK_STATE_CONNECTED:
      {
        m_iNetConState = REF_CNE_NET_STATE_CONNECTED;
		RCNE_MSG_DEBUG("refcne %d radio state is connected",m_iMyRatType);
      }
      break;
    default:
      {
        m_iNetConState = REF_CNE_NET_STATE_DISCONNECTED;
		RCNE_MSG_DEBUG("refcne %d radio state is disconnected",m_iMyRatType);
      }
  }
  
  return;
}
/*=============================================================================
  FUNCTION      TurnOn

  DESCRIPTION   Turns the radio on

  DEPENDENCIES  None

  RETURN VALUE  None

  SIDE EFFECTS  None
 ============================================================================*/
void CRefCneRadio::TurnOn
(
)
{
  //Send Turn On command to Connectivity daemon
  RCNE_MSG_DEBUG("requesting service to turn on radio with params: cmd %d, sz %d, radio %d",
				 CNE_REQUEST_BRING_RAT_UP_MSG,(sizeof(m_iMyRatType)),m_iMyRatType);
  cne_sendUnsolicitedMsg
    (0, CNE_REQUEST_BRING_RAT_UP_MSG, sizeof(m_iMyRatType), &m_iMyRatType);
  return;
}
/*=============================================================================
  FUNCTION      TurnOff

  DESCRIPTION   Turns the radio off

  DEPENDENCIES  None

  RETURN VALUE  None

  SIDE EFFECTS  None
 ============================================================================*/
void CRefCneRadio::TurnOff
(
)
{
  //Send Turn Off command to Connectivity daemon
  RCNE_MSG_DEBUG("requesting service to turn off radio with params: cmd %d, sz %d, radio %d",
				 CNE_REQUEST_BRING_RAT_DOWN_MSG,(sizeof(m_iMyRatType)),m_iMyRatType);
  cne_sendUnsolicitedMsg
    (0, CNE_REQUEST_BRING_RAT_DOWN_MSG, sizeof(m_iMyRatType), &m_iMyRatType);
  return;
}
/*=============================================================================
  FUNCTION      SetPending

  DESCRIPTION   Sets the pending flag appropriately when radio is turned on
                or off

  DEPENDENCIES  None

  RETURN VALUE  None

  SIDE EFFECTS  None
 ============================================================================*/
void CRefCneRadio::SetPending
(
  ref_cne_net_con_req_enum_type flag
)
{
  RCNE_MSG_DEBUG("SP: setting network [%d] request status to [%d]",
                 m_iMyRatType,flag);
  m_iRequestState = flag;
}

//Implicit constructor
CRefCneRadio::CRefCneRadio
(
)
{
}