1 /* Copyright (c) 2011-2012, The Linux Foundation. All rights reserved.
2  *
3  * Redistribution and use in source and binary forms, with or without
4  * modification, are permitted provided that the following conditions are
5  * met:
6  *     * Redistributions of source code must retain the above copyright
7  *       notice, this list of conditions and the following disclaimer.
8  *     * Redistributions in binary form must reproduce the above
9  *       copyright notice, this list of conditions and the following
10  *       disclaimer in the documentation and/or other materials provided
11  *       with the distribution.
12  *     * Neither the name of The Linux Foundation, nor the names of its
13  *       contributors may be used to endorse or promote products derived
14  *       from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  */
29 
30 #define LOG_NDDEBUG 0
31 
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <sys/time.h>
35 #include <time.h>
36 #include "loc_log.h"
37 #include "msg_q.h"
38 #ifdef USE_GLIB
39 #include <time.h>
40 #endif /* USE_GLIB  */
41 #include "log_util.h"
42 #include "platform_lib_includes.h"
43 
44 #define  BUFFER_SIZE  120
45 
46 // Logging Improvements
47 const char *loc_logger_boolStr[]={"False","True"};
48 const char VOID_RET[]   = "None";
49 const char FROM_AFW[]   = "===>";
50 const char TO_MODEM[]   = "--->";
51 const char FROM_MODEM[] = "<---";
52 const char TO_AFW[]     = "<===";
53 const char EXIT_TAG[]   = "Exiting";
54 const char ENTRY_TAG[]  = "Entering";
55 
56 /* Logging Mechanism */
57 loc_logger_s_type loc_logger;
58 
59 /* Get names from value */
loc_get_name_from_mask(loc_name_val_s_type table[],int table_size,long mask)60 const char* loc_get_name_from_mask(loc_name_val_s_type table[], int table_size, long mask)
61 {
62    int i;
63    for (i = 0; i < table_size; i++)
64    {
65       if (table[i].val & (long) mask)
66       {
67          return table[i].name;
68       }
69    }
70    return UNKNOWN_STR;
71 }
72 
73 /* Get names from value */
loc_get_name_from_val(loc_name_val_s_type table[],int table_size,long value)74 const char* loc_get_name_from_val(loc_name_val_s_type table[], int table_size, long value)
75 {
76    int i;
77    for (i = 0; i < table_size; i++)
78    {
79       if (table[i].val == (long) value)
80       {
81          return table[i].name;
82       }
83    }
84    return UNKNOWN_STR;
85 }
86 
87 static loc_name_val_s_type loc_msg_q_status[] =
88 {
89     NAME_VAL( eMSG_Q_SUCCESS ),
90     NAME_VAL( eMSG_Q_FAILURE_GENERAL ),
91     NAME_VAL( eMSG_Q_INVALID_PARAMETER ),
92     NAME_VAL( eMSG_Q_INVALID_HANDLE ),
93     NAME_VAL( eMSG_Q_UNAVAILABLE_RESOURCE ),
94     NAME_VAL( eMSG_Q_INSUFFICIENT_BUFFER )
95 };
96 static int loc_msg_q_status_num = sizeof(loc_msg_q_status) / sizeof(loc_name_val_s_type);
97 
98 /* Find msg_q status name */
loc_get_msg_q_status(int status)99 const char* loc_get_msg_q_status(int status)
100 {
101    return loc_get_name_from_val(loc_msg_q_status, loc_msg_q_status_num, (long) status);
102 }
103 
log_succ_fail_string(int is_succ)104 const char* log_succ_fail_string(int is_succ)
105 {
106    return is_succ? "successful" : "failed";
107 }
108 
109 //Target names
110 loc_name_val_s_type target_name[] =
111 {
112     NAME_VAL(GNSS_NONE),
113     NAME_VAL(GNSS_MSM),
114     NAME_VAL(GNSS_GSS),
115     NAME_VAL(GNSS_MDM),
116     NAME_VAL(GNSS_QCA1530),
117     NAME_VAL(GNSS_UNKNOWN)
118 };
119 
120 static int target_name_num = sizeof(target_name)/sizeof(loc_name_val_s_type);
121 
122 /*===========================================================================
123 
124 FUNCTION loc_get_target_name
125 
126 DESCRIPTION
127    Returns pointer to a string that contains name of the target
128 
129    XX:XX:XX.000\0
130 
131 RETURN VALUE
132    The target name string
133 
134 ===========================================================================*/
loc_get_target_name(unsigned int target)135 const char *loc_get_target_name(unsigned int target)
136 {
137     int index = 0;
138     static char ret[BUFFER_SIZE];
139 
140     index =  getTargetGnssType(target);
141     if( index >= target_name_num || index < 0)
142         index = target_name_num - 1;
143 
144     if( (target & HAS_SSC) == HAS_SSC ) {
145         snprintf(ret, sizeof(ret), " %s with SSC",
146            loc_get_name_from_val(target_name, target_name_num, (long)index) );
147     }
148     else {
149        snprintf(ret, sizeof(ret), " %s  without SSC",
150            loc_get_name_from_val(target_name, target_name_num, (long)index) );
151     }
152     return ret;
153 }
154 
155 
156 /*===========================================================================
157 
158 FUNCTION loc_get_time
159 
160 DESCRIPTION
161    Logs a callback event header.
162    The pointer time_string should point to a buffer of at least 13 bytes:
163 
164    XX:XX:XX.000\0
165 
166 RETURN VALUE
167    The time string
168 
169 ===========================================================================*/
loc_get_time(char * time_string,unsigned long buf_size)170 char *loc_get_time(char *time_string, unsigned long buf_size)
171 {
172    struct timeval now;     /* sec and usec     */
173    struct tm now_tm;       /* broken-down time */
174    char hms_string[80];    /* HH:MM:SS         */
175 
176    gettimeofday(&now, NULL);
177    localtime_r(&now.tv_sec, &now_tm);
178 
179    strftime(hms_string, sizeof hms_string, "%H:%M:%S", &now_tm);
180    snprintf(time_string, buf_size, "%s.%03d", hms_string, (int) (now.tv_usec / 1000));
181 
182    return time_string;
183 }
184 
185 
186 /*===========================================================================
187 FUNCTION loc_logger_init
188 
189 DESCRIPTION
190    Initializes the state of DEBUG_LEVEL and TIMESTAMP
191 
192 DEPENDENCIES
193    N/A
194 
195 RETURN VALUE
196    None
197 
198 SIDE EFFECTS
199    N/A
200 ===========================================================================*/
loc_logger_init(unsigned long debug,unsigned long timestamp)201 void loc_logger_init(unsigned long debug, unsigned long timestamp)
202 {
203    loc_logger.DEBUG_LEVEL = debug;
204 #ifdef TARGET_BUILD_VARIANT_USER
205    // force user builds to 2 or less
206    if (loc_logger.DEBUG_LEVEL > 2) {
207        loc_logger.DEBUG_LEVEL = 2;
208    }
209 #endif
210    loc_logger.TIMESTAMP   = timestamp;
211 }
212 
213 
214 /*===========================================================================
215 FUNCTION get_timestamp
216 
217 DESCRIPTION
218    Generates a timestamp using the current system time
219 
220 DEPENDENCIES
221    N/A
222 
223 RETURN VALUE
224    Char pointer to the parameter str
225 
226 SIDE EFFECTS
227    N/A
228 ===========================================================================*/
get_timestamp(char * str,unsigned long buf_size)229 char * get_timestamp(char *str, unsigned long buf_size)
230 {
231   struct timeval tv;
232   struct timezone tz;
233   int hh, mm, ss;
234   gettimeofday(&tv, &tz);
235   hh = tv.tv_sec/3600%24;
236   mm = (tv.tv_sec%3600)/60;
237   ss = tv.tv_sec%60;
238   snprintf(str, buf_size, "%02d:%02d:%02d.%06ld", hh, mm, ss, tv.tv_usec);
239   return str;
240 }
241 
242