bsdlib: release 0.5.0

* `bsd_irrecoverable_error_handler()` has been removed.
  The application now longer needs to implement it to receive errors
  during initialization, which are instead reported via `bsd_init()`.
* `bsd_shutdown()` now returns an integer.
* Added RAW socket support.
* Added missing AGPS data models.
* Added APGS nofification support.
* Fixed an issue where AGPS data can not be written
  when the GPS socket is in stopped state
* Fixed a memory leak in the GPS socket

Internal revision: 4303c58ecf7

Signed-off-by: Emanuele Di Santo <[email protected]>
Signed-off-by: Bartosz Gentkowski <[email protected]>

Author: lemrey

bsdlib/CHANGELOG.rst

@@ -5,6 +5,19 @@ Changelog
 
 All notable changes to this project are documented in this file.
 
+bsdlib 0.5.0
+************
+
+* :cpp:func:`bsd_irrecoverable_handler()` has been removed.
+  The application no longer needs to implement it to receive errors during initialization, which are instead reported via :cpp:func:`bsd_init()`.
+* :cpp:func:`bsd_shutdown()` now returns an integer.
+* Added RAW socket support.
+* Added missing AGPS data models.
+* Added APGS notification support.
+* Fixed an issue where AGPS data could not be written when the GPS socket was in stopped state.
+* Fixed a memory leak in GPS socket.
+
+
 bsdlib 0.4.3
 ************
 

bsdlib/include/bsd.h

@@ -9,19 +9,24 @@
  * @defgroup bsd BSD Library Management
  * @ingroup bsd_library
  * @{
- * @brief Application Interface offered for management of BSD Library.
+ * @brief Application interface offered for management of BSD Library.
  */
 #ifndef BSD_H__
 #define BSD_H__
 
 #include <stdint.h>
 
-#include "bsd_limits.h"
-
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+/**
+ * @defgroup bsd_modem_dfu
+ *           @c bsd_init() return values when executing Modem firmware updates.
+ *
+ * @ingroup bsd_library
+ * @{
+ */
 
 /** Modem firmware update successful.
   * The modem will run the updated firmware on reboot.
@@ -46,57 +51,44 @@ extern "C" {
   */
 #define MODEM_DFU_RESULT_UUID_ERROR 0x4400004u
 
+/**@} */
+
 /**
- * @brief Method to initialize BSD library.
- *
- * @details This method shall be called before using any of the other methods of the application.
- *          In case the initialization fails, the call results in a hard fault.
- *
- *          This method shall be called once. Calling this method again with a shutdown results
- *          in undefined behavior.
+ * @brief Initialize the library.
  *
- *          Initializing the library results in reserving resources defined in bsd_platform.h on
- *          the system. The application shall not use any of the resources identified in
- *          bsd_platform.h.
+ * Once initialized, the library uses the resources defined in bsd_platform.h.
  *
- * @return Zero on success or an error code otherwise.
+ * @retval Zero on success.
+ * @retval A positive value from @ref bsd_modem_dfu when executing
+ *         Modem firmware updates.
+ * @retval -1 on error.
  */
 int bsd_init(void);
 
 
 /**
- * @brief Method to gracefully shutdown the BSD library.
+ * @brief Shutdown the library.
  *
- * @details This method used to shutdown the library. Resources reserved by the system may be reused
- *          once the library is gracefully shutdown.
- */
-void bsd_shutdown(void);
-
-
-/**
- * @brief Handler for recoverable BSD library errors.
- *
- * @note  It can be overwritten by the application.
- *        The default will hard fault.
+ * Resources reserved by the library in bsd_platform.h are freed when
+ * the library is shutdown.
  *
- * @param[in] error Indicates the error that occurred.
+ * @retval Zero on success.
+ * @retval -1 on error.
  */
-extern void bsd_recoverable_error_handler(uint32_t error);
+int bsd_shutdown(void);
 
 
 /**
- * @brief Handler for irrecoverable BSD library errors.
- *
- * @note  It can be overwritten by the application.
- *        The default will hard fault.
+ * @brief Handler for BSD library errors.
  *
- * @param[in] error Indicates the error that occurred.
+ * @param[in] error The error reason.
  */
-extern void bsd_irrecoverable_error_handler(uint32_t error);
+extern void bsd_recoverable_error_handler(uint32_t error);
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif // BSD_H__
+
 /**@} */

bsdlib/include/nrf_socket.h

@@ -73,6 +73,7 @@ typedef int32_t ssize_t;
  */
 #define NRF_AF_LOCAL            1   /**< Family to identify protocols/operations local to Nordic device. */
 #define NRF_AF_INET             2   /**< IPv4 socket family. */
+#define NRF_AF_PACKET           5   /**< Raw packet family. */
 #define NRF_AF_INET6            10  /**< IPv6 socket family. */
 #define NRF_AF_LTE              102 /**< Nordic proprietary LTE socket family. */
 /**@} */
@@ -83,6 +84,7 @@ typedef int32_t ssize_t;
  */
 #define NRF_SOCK_STREAM         1   /**< TCP socket type. */
 #define NRF_SOCK_DGRAM          2   /**< UDP socket type. */
+#define NRF_SOCK_RAW            3   /**< RAW socket type. */
 /**@} */
 
 /**@defgroup nrf_socket_mgmt_types Nordic specific extensions of nrf_socket_type_t
@@ -197,6 +199,8 @@ typedef int32_t ssize_t;
 #define NRF_GNSS_AGPS_KLOBUCHAR_IONOSPHERIC_CORRECTION 4 /**< GPS ionospheric assistance AGPS parameters, Klobuchar model. */
 #define NRF_GNSS_AGPS_NEQUICK_IONOSPHERIC_CORRECTION   5 /**< GPS ionospheric assistance AGPS parameters, NeQuick model. */
 #define NRF_GNSS_AGPS_GPS_SYSTEM_CLOCK_AND_TOWS        6 /**< GPS system time and SV TOW assistance AGPS parameter. */
+#define NRF_GNSS_AGPS_LOCATION                         7 /**< GPS location assistance AGPS parameters */
+#define NRF_GNSS_AGPS_INTEGRITY                        8 /**< GPS integrity assistance AGPS parameters */
 /** @} */
 
 /**@defgroup nrf_nmea_str_mask Set of values (as bitmask) to enable NMEA output strings
@@ -591,8 +595,16 @@ typedef struct
 
 typedef char nrf_gnss_nmea_data_frame_t[NRF_GNSS_NMEA_MAX_LEN];
 
+typedef struct
+{
+    uint32_t sv_mask_ephe;
+    uint32_t sv_mask_alm;
+    uint32_t data_flags;
+} nrf_gnss_agps_data_frame_t;
+
 #define NRF_GNSS_PVT_DATA_ID  1
 #define NRF_GNSS_NMEA_DATA_ID 2
+#define NRF_GNSS_AGPS_DATA_ID 3
 
 typedef struct
 {
@@ -601,6 +613,7 @@ typedef struct
     {
         nrf_gnss_pvt_data_frame_t  pvt;
         nrf_gnss_nmea_data_frame_t nmea;
+        nrf_gnss_agps_data_frame_t agps;
     };
 } nrf_gnss_data_frame_t;
 
@@ -622,6 +635,8 @@ typedef struct
  *          - @c NRF_GNSS_AGPS_KLOBUCHAR_IONOSPHERIC_CORRECTION
  *          - @c NRF_GNSS_AGPS_NEQUICK_IONOSPHERIC_CORRECTION
  *          - @c NRF_GNSS_AGPS_GPS_SYSTEM_CLOCK_AND_TOWS
+ *          - @c NRF_GNSS_AGPS_LOCATION
+ *          - @c NRF_GNSS_AGPS_INTEGRITY
  */
 typedef uint16_t nrf_gnss_agps_data_type_t;
 
@@ -724,6 +739,59 @@ typedef struct
     nrf_gnss_agps_data_tow_element_t sv_tow[NRF_GNSS_AGPS_MAX_SV_TOW]; /**< TOW assistance data for PRN n */
 } nrf_gnss_agps_data_system_time_and_sv_tow_t;
 
+typedef struct
+{
+    int32_t latitude;          /**< Geodetic latitude in WGS-84. Range -8388607...8388607.
+                                *   The relation between the coded number N and the latitude
+                                *   range X (in degrees) is as follows: N <= (2^24/360) * X < N + 1.
+                                *   For N = 2^23 - 1, the range is extended to include N+1.
+                                *   Range of X (in degrees) -90...90.
+                                */
+
+    int32_t longitude;         /**< Geodetic longitude in WGS-84. Range -8388607..8388607.
+                                *   The relation between the coded number N and the longitude range
+                                *   X (in degrees) is as follows: N <= (2^24/360) * X < N + 1.
+                                *   Range of X (in degrees) -180...180.
+                                */
+
+    int16_t altitude;          /**< Altitude. Above (positive value) or below (negative value) WGS-84
+                                *   ellipsoid surface. Range -32767...32767.
+                                *   The relation between the coded number N and the altitude range a
+                                *   (in meters) is as follows: N <= a < N + 1.
+                                *   For N = 2^15 - 1 the range is extended to include all greater values of a.
+                                */
+
+    uint8_t unc_semimajor;     /**< Uncertainty, semi-major. Range 0...127. The uncertainty (in meters) is
+                                *   mapped from the coded number K with following formula: r = C * (K - 1),
+                                *   where C = 10 and x = 0,1. Range of r (in kilometers) 0...1800.
+                                */
+
+    uint8_t unc_semiminor;     /**< Uncertainty, semi-minor. Range 0...127. The uncertainty (in meters) is
+                                *   mapped from the coded number K with following formula: r = C * (K - 1),
+                                *   where C = 10 and x = 0,1. Range of r (in kilometers) 0...1800)
+                                */
+
+    uint8_t orientation_major; /**< Orientation angle between the major axis and north. Range in degrees 0...179. */
+
+    uint8_t unc_altitude;      /**< Uncertainty, altitude. Range 0...127. The uncertainty in altitude h (in meters)
+                                *   is mapped from the coded number K with following formula: h = C * (K - 1).
+                                *   where C = 45 and x = 0,025. Range of h (in meters) 0...990,5.
+                                */
+
+    uint8_t confidence;        /**< The confidence level (expressed as a percentage) with which
+                                *   the position of a target entity is included within the uncertainty ellipsoid.
+                                *   Range 0...128. '0' indicates 'no information'. Values 101..128  should be treated as '0'.
+                                */
+} nrf_gnss_agps_data_location_t;
+
+
+typedef struct
+{
+    uint32_t integrity_mask; /**< Bit mask indicating the unhealthy GPS satellite PRNs. When a mask bit is set,
+                              *   the corresponding GPS satellite PRN is unhealthy.
+                              */
+} nrf_gnss_agps_data_integrity_t;
+
 /** @} */
 
 /**@defgroup nrf_socketopt_gnss GNSS socket option