Robert Schmidt
6ae4ec37ca
Remove the \file directive, as it is always superfluous because the current file is implicit [1]: > If the file name is omitted (i.e. the line after \file is left blank) > then the documentation block that contains the \file command will belong > to the file it is located in. Author names and e-mails are not relevant for us: it can always be inferred from git blame, and is often outdated. Eurecom code has been contributed and was under OAI PL v1.0/v1.1. For the cpack package contact: put generic email address that is independent of an individual and that will remain reachable. [1] https://www.doxygen.nl/manual/commands.html#cmdfile
122 lines
4.4 KiB
C
122 lines
4.4 KiB
C
/*
|
|
* Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership.
|
|
* The OpenAirInterface Software Alliance licenses this file to You under
|
|
* the OAI Public License, Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.openairinterface.org/?page_id=698
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*-------------------------------------------------------------------------------
|
|
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
|
* contact@openairinterface.org
|
|
*/
|
|
|
|
/*****************************************************************************
|
|
|
|
Source user_indication.h
|
|
|
|
Version 0.1
|
|
|
|
Date 2012/10/25
|
|
|
|
Product NAS stack
|
|
|
|
Subsystem Application Programming Interface
|
|
|
|
Description Defines functions which allow the user application to register
|
|
procedures to be executed upon receiving asynchronous notifi-
|
|
cation.
|
|
|
|
*****************************************************************************/
|
|
#ifndef __USER_IND_H__
|
|
#define __USER_IND_H__
|
|
|
|
#include "commonDef.h"
|
|
#include "networkDef.h"
|
|
#include "user_api_defs.h"
|
|
|
|
/****************************************************************************/
|
|
/********************* G L O B A L C O N S T A N T S *******************/
|
|
/****************************************************************************/
|
|
|
|
/*
|
|
* Type of notification that may be asynchronously received by the user
|
|
*/
|
|
typedef enum {
|
|
USER_IND_REG = 0, /* Registration notification */
|
|
USER_IND_LOC, /* Location notification */
|
|
USER_IND_PLMN, /* Network notification */
|
|
USER_IND_PDN, /* PDN connection notification */
|
|
USER_IND_MAX
|
|
} user_ind_t;
|
|
|
|
/*
|
|
* Registration notification are received whenever there is a change in the
|
|
* UE's network registration status in GERAN/UTRAN/E-UTRAN
|
|
*/
|
|
typedef struct {
|
|
Stat_t status; /* network registration status */
|
|
} user_ind_reg_t;
|
|
|
|
/*
|
|
* Location notification are received whenever there is a change in the
|
|
* network serving cell in GERAN/UTRAN/E-UTRAN
|
|
*/
|
|
typedef struct {
|
|
Stat_t status; /* network registration status */
|
|
tac_t tac; /* Location/Tracking area code */
|
|
ci_t ci; /* GERAN/UTRAN/E-UTRAN cell ID */
|
|
AcT_t AcT; /* Supported Access Technology */
|
|
} user_ind_loc_t;
|
|
|
|
/*
|
|
* PDN connection notification are received whenever the user or the network
|
|
* has activated or desactivated a PDN connection
|
|
*/
|
|
typedef struct {
|
|
uint8_t cid; /* PDN connection identifier */
|
|
network_pdn_state_t status; /* PDN connection status */
|
|
} user_ind_pdn_t;
|
|
|
|
/*
|
|
* Structure of asynchronous notification received by the user
|
|
*/
|
|
typedef struct {
|
|
union {
|
|
user_ind_reg_t reg; /* Registration notification */
|
|
user_ind_loc_t loc; /* Location notification */
|
|
user_ind_pdn_t pdn; /* PDN connection notification */
|
|
} notification;
|
|
} user_indication_t;
|
|
|
|
/*
|
|
* Type of procedure executed upon receiving registered notification
|
|
*/
|
|
typedef int (*user_ind_callback_t) (user_api_id_t *user_api_id, unsigned char, const void*, size_t);
|
|
|
|
/****************************************************************************/
|
|
/************************ G L O B A L T Y P E S ************************/
|
|
/****************************************************************************/
|
|
|
|
/****************************************************************************/
|
|
/******************** G L O B A L V A R I A B L E S ********************/
|
|
/****************************************************************************/
|
|
|
|
/****************************************************************************/
|
|
/****************** E X P O R T E D F U N C T I O N S ******************/
|
|
/****************************************************************************/
|
|
|
|
int user_ind_register(user_ind_t ind, unsigned char id, user_ind_callback_t cb);
|
|
int user_ind_deregister(user_ind_t ind);
|
|
int user_ind_notify(user_api_id_t *user_api_id, user_ind_t ind, const void* data, size_t size);
|
|
|
|
#endif /* __USER_IND_H__*/
|