Files @ ab7abb62e433
Branch filter:

Location: therm/drivers/STM32F0xx_HAL_Driver/Src/stm32f0xx_hal_ppp.c

Ethan Zonca
Import new project based on CANtact makefile template
  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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
/**
  ******************************************************************************
  * @file    stm32f0xx_hal_ppp.c
  * @author  MCD Application Team
  * @version V1.1.0
  * @date    03-Oct-2014
  * @brief   PPP HAL module driver.
  *          This file provides firmware functions to manage the following 
  *          functionalities of the PPP peripheral:
  *           + Initialization/de-initialization functions
  *           + I/O operation functions
  *           + Peripheral Control functions 
  *           + Peripheral State functions
  *         
  @verbatim
================================================================================
          ##### Product specific features integration #####
================================================================================
           
  [..]  This section can contain: 
       (#) Description of the product specific implementation; all features
           that is specific to this IP: separate clock for RTC/LCD/IWDG/ADC,
           power domain (backup domain for the RTC)...   
       (#) IP main features, only when needed and not mandatory for all IPs,
           ex. for xWDG, GPIO, COMP...

  [..]  You can add as much sections as needed.

  [..]  You can add as much sections as needed.

            ##### How to use this driver #####
================================================================================
           [..]
            (#) Add here ALL NEEDED STEPS (i.e. list of functions and parameters) 
                TO INITIALIZE AND USE THE PERIPHERAL. Following the listed steps, 
                user should be able to make the peripheral working without any
                additional information from other resources (ex. product Reference 
                Manual, HAL User Manual...).   
 
                Basically, it should be the same as we provide in the examples.
 
            (#) Exception can be made for system IPs (there is no standard order
                of API usage) for which the description of API usage will be made
                in each function group. These IPs are: PWR, RCC and FLASH
                In this case, this section should contain the following note:
                "Refer to the description within the different function groups below"
  
            (+) 
  
            (+) 
  
            (+) 
  
            (+) 
  
            (+) 
  
            (+) 
  
  @endverbatim
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  *
  * Redistribution and use in source and binary forms, with or without modification,
  * are permitted provided that the following conditions are met:
  *   1. Redistributions of source code must retain the above copyright notice,
  *      this list of conditions and the following disclaimer.
  *   2. 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.
  *   3. Neither the name of STMicroelectronics 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 AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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.
  *
  ******************************************************************************  
  */

/* Includes ------------------------------------------------------------------*/
#include "stm32f0xx_hal.h"

/** @addtogroup STM32F0xx_HAL_Driver
  * @{
  */

/** @defgroup PPP PPP HAL module driver
  * @brief PPP HAL module driver
  * @{
  */

#ifdef HAL_PPP_MODULE_ENABLED

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/* Exported functions ---------------------------------------------------------*/
/** @defgroup PPP_Exported_Functions PPP Exported Functions
  * @{
  */

/** @defgroup PPP_Exported_Functions_Group1 Initialization/de-initialization functions 
 *  @brief    Initialization and Configuration functions 
 *
@verbatim    
 ===============================================================================
              ##### Initialization and Configuration functions #####
 ===============================================================================
    [..]  This section provides functions allowing to:
 
@endverbatim
  * @{
  */

/**
  * @brief  Initializes the PPP according to the specified
  *         parameters in the PPP_InitTypeDef and create the associated handle.
  * @param  hppp: PPP handle
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Init(PPP_HandleTypeDef *hppp)
{ 

  /* Check the parameters */
  assert_param(IS_PPP_CONFIGx(hppp->Config.Config1)); 

  /* Check the PPP handle allocation */
  if(hppp == NULL)
  {
    return HAL_ERROR;
  }
 
  /* Init the low level hardware : GPIO, CLOCK, NVIC and DMA */
  HAL_PPP_MspInit(hppp);
  
  /* Set PPP parameters */
  
  /* Enable the Peripharal */
  
  /* Initialize the PPP state*/
  hppp->State = HAL_PPP_STATE_READY;
  
  return HAL_OK;
}

/**
  * @brief  DeInitializes the PPP peripheral 
  * @param  hppp: PPP handle
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_DeInit(PPP_HandleTypeDef *hppp)
{
  /* Check the PPP peripheral state */
  if(hppp->State == HAL_PPP_STATE_BUSY)
  {
     return HAL_ERROR;
  }

  hppp->State = HAL_PPP_STATE_BUSY;
  
  /* DeInit the low level hardware: GPIO, CLOCK, NVIC and DMA */
  HAL_PPP_MspDeInit(hppp);
    
  hppp->State = HAL_PPP_STATE_DISABLED; 
  return HAL_OK;
}

/**
  * @brief  Initializes the PPP MSP.
  * @param  hppp: PPP handle
  * @retval None
  */
__weak void HAL_PPP_MspInit(PPP_HandleTypeDef *hppp)
{
  /* NOTE : This function Should not be modified, when the callback is needed,
            the HAL_PPP_MspInit could be implenetd in the user file
   */
}

/**
  * @brief  DeInitializes PPP MSP.
  * @param  hppp: PPP handle
  * @retval None
  */
__weak void HAL_PPP_MspDeInit(PPP_HandleTypeDef *hppp)
{
  /* NOTE : This function Should not be modified, when the callback is needed,
            the HAL_PPP_MspDeInit could be implenetd in the user file
   */
}

/**
  * @}
  */

/** @defgroup PPP_Exported_Functions_Group2 I/O operation functions 
 *  @brief   Data transfers functions 
 *
@verbatim   
 ===============================================================================
                      ##### IO operation functions #####
 ===============================================================================  
    [..]
    This subsection provides a set of functions allowing to manage the PPP data 
    transfers.

@endverbatim
  * @{
  */

/**
  * @brief  Send an amount of data in blocking mode 
  * @param  hppp: PPP handle
  * @param  pData: pointer to data buffer
  * @param  Size: amount of data to be sent
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Transmit(PPP_HandleTypeDef *hppp, uint8_t *pData, uint16_t Size)
{
  /* Process Locked */
  __HAL_LOCK(hppp);
  
  hppp->State = HAL_PPP_STATE_BUSY;  
  /* PPP processing... */ 
  hppp->State = HAL_PPP_STATE_READY; 
                  
  /* Process Unlocked */
  __HAL_UNLOCK(hppp);      
  
  return HAL_OK;
}

/**
  * @brief  Receive an amount of data in blocking mode 
  * @param  hppp: PPP handle
  * @param  pData: pointer to data buffer
  * @param  Size: amount of data to be received
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Receive(PPP_HandleTypeDef *hppp, uint8_t *pData, uint16_t Size)
{ 
  /* Process Locked */
  __HAL_LOCK(hppp);
  
  hppp->State = HAL_PPP_STATE_BUSY;  
  /* PPP processing... */ 
  hppp->State = HAL_PPP_STATE_READY; 
                  
  /* Process Unlocked */
  __HAL_UNLOCK(hppp);      
  
  return HAL_OK;
}

/**
  * @brief  Send an amount of data in non blocking mode 
  * @param  hppp: PPP handle
  * @param  pData: pointer to data buffer
  * @param  Size: amount of data to be sent
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Transmit_IT(PPP_HandleTypeDef *hppp, uint8_t *pData, uint16_t Size)
{
  /* Process Locked */
  __HAL_LOCK(hppp);
  
  hppp->State = HAL_PPP_STATE_BUSY;  
  /* PPP processing... */ 
  hppp->State = HAL_PPP_STATE_READY; 
                  
  /* Process Unlocked */
  __HAL_UNLOCK(hppp);      
  
  return HAL_OK;
}

/**
  * @brief  Receive an amount of data in non blocking mode 
  * @param  hppp: PPP handle
  * @param  pData: pointer to data buffer
  * @param  Size: amount of data to be received
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Receive_IT(PPP_HandleTypeDef *hppp, uint8_t *pData, uint16_t Size)
{
  /* Process Locked */
  __HAL_LOCK(hppp);
  
  hppp->State = HAL_PPP_STATE_BUSY;  
  /* PPP processing... */ 
  hppp->State = HAL_PPP_STATE_READY; 
                  
  /* Process Unlocked */
  __HAL_UNLOCK(hppp);      
  
  return HAL_OK;
}

/**
  * @brief  This function handles PPP interrupt request.
  * @param  hppp: PPP handle
  * @retval HAL status
  */
void HAL_PPP_IRQHandler(PPP_HandleTypeDef *hppp)
{
  /* PPP in mode Tramitter ---------------------------------------------------*/
  if (__HAL_PPP_GET_IT(hppp, PPP_IT_TC) != RESET)
  { 
    __HAL_PPP_CLEAR_IT(hppp, PPP_IT_TC);
    HAL_PPP_Transmit_IT(hppp, NULL, 0);
  }
  
  /* PPP in mode Receiver ----------------------------------------------------*/
  if (__HAL_PPP_GET_IT(hppp, PPP_IT_RXNE) != RESET)
  {
    __HAL_PPP_CLEAR_IT(hppp, PPP_IT_RXNE);
    HAL_PPP_Receive_IT(hppp, NULL, 0);
  } 
}

/**
  * @brief  Tx Transfer completed callbacks
  * @param  hppp: ppp handle
  * @retval None
  */
 __weak void HAL_PPP_TxCpltCallback(PPP_HandleTypeDef *hppp)
{
  /* NOTE : This function Should not be modified, when the callback is needed,
            the HAL_PPP_TxCpltCallback could be implenetd in the user file
   */ 
}

/**
  * @brief  Rx Transfer completed callbacks
  * @param  hppp: PPP handle
  * @retval None
  */
__weak void HAL_PPP_RxCpltCallback(PPP_HandleTypeDef *hppp)
{
  /* NOTE : This function Should not be modified, when the callback is needed,
            the HAL_PPP_TxCpltCallback could be implenetd in the user file
   */ 
}

/**
  * @brief  Send an amount of data in non blocking mode 
  * @param  hppp: ppp handle
  * @param  pData: pointer to data buffer
  * @param  Size: amount of data to be sent
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Transmit_DMA(PPP_HandleTypeDef *hppp, uint8_t *pData, uint16_t Size)
{
  /* Check the PPP peripheral state */
  if(hppp->State == HAL_PPP_STATE_BUSY)
  {
     return HAL_BUSY;
  }
  
  /* Process Locked */
  __HAL_LOCK(hppp);
  
  hppp->State = HAL_PPP_STATE_BUSY;  
  /* PPP processing... */ 
  hppp->State = HAL_PPP_STATE_READY; 
                  
  /* Process Unlocked */
  __HAL_UNLOCK(hppp);      
  
  return HAL_OK;
}

/**
  * @brief  Receive an amount of data in non blocking mode 
  * @param  hppp: PPP handle
  * @param  pData: pointer to data buffer
  * @param  Size: amount of data to be received
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Receive_DMA(PPP_HandleTypeDef *hppp, uint8_t *pData, uint16_t Size)
{
  /* Check the PPP peripheral state */
  if(hppp->State == HAL_PPP_STATE_BUSY)
  {
     return HAL_BUSY;
  }
  
  /* Process Locked */
  __HAL_LOCK(hppp);
  
  hppp->State = HAL_PPP_STATE_BUSY;  
  /* PPP processing... */ 
  hppp->State = HAL_PPP_STATE_READY; 
                  
  /* Process Unlocked */
  __HAL_UNLOCK(hppp);      
  
  return HAL_OK;
}

/**
  * @}
  */

/** @defgroup PPP_Exported_Functions_Group3 Peripheral Control functions 
 *  @brief   management functions 
 *
@verbatim   
 ===============================================================================
                      ##### Peripheral Control functions #####
 ===============================================================================  
    [..]
    This subsection provides a set of functions allowing to control the PPP data 
    transfers.

@endverbatim
  * @{
  */

/**
  * @brief  Configures PPP features and fonctionality. 
  * @param  hppp: PPP handle
  * @param  control: Specifies which PPP_InitTypeDef structure’s field will be affected
  * @param  Size: amount of data to be sent
  * @retval HAL status
  */
HAL_StatusTypeDef HAL_PPP_Ctl(PPP_HandleTypeDef *hppp, PPP_ControlTypeDef  control, uint16_t *args)
{
  if(hppp->State == HAL_PPP_STATE_BUSY)
  {
     return HAL_BUSY;
  }

  hppp->State = HAL_PPP_STATE_BUSY;

  /* Update the PPP features and fonctionality */
  /* ... */
  
  hppp->State = HAL_PPP_STATE_READY;
  
  return HAL_OK; 
}
/**
  * @}
  */

/** @defgroup PPP_Exported_Functions_Group4 Peripheral State functions
 *  @brief   Peripheral State functions 
 *
@verbatim   
 ===============================================================================
                      ##### Peripheral State functions #####
 ===============================================================================  
    [..]
    This subsection permit to get in run-time the status of the peripheral 
    and the data flow.

@endverbatim
  * @{
  */

/**
  * @brief  Return the PPP state
  * @param  hppp : PPP handle
  * @retval HAL state
  */
HAL_PPP_StateTypeDef HAL_PPP_GetState(PPP_HandleTypeDef *hppp)
{
  return hppp->State;
}
/**
  * @}
  */

/**
  * @}
  */

#endif /* HAL_PPP_MODULE_ENABLED */
/**
  * @}
  */

/**
  * @}
  */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/