task.h 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. /****************************************************************************
  2. * sched/task/task.h
  3. *
  4. * Copyright (C) 2007-2014 Gregory Nutt. All rights reserved.
  5. * Author: Gregory Nutt <gnutt@nuttx.org>
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions
  9. * are met:
  10. *
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in
  15. * the documentation and/or other materials provided with the
  16. * distribution.
  17. * 3. Neither the name NuttX nor the names of its contributors may be
  18. * used to endorse or promote products derived from this software
  19. * without specific prior written permission.
  20. *
  21. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24. * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25. * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26. * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27. * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  28. * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29. * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31. * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32. * POSSIBILITY OF SUCH DAMAGE.
  33. *
  34. ****************************************************************************/
  35. #ifndef __SCHED_TASK_TASK_H
  36. #define __SCHED_TASK_TASK_H
  37. /****************************************************************************
  38. * Included Files
  39. ****************************************************************************/
  40. #include <nuttx/config.h>
  41. #include <nuttx/compiler.h>
  42. #include <sys/types.h>
  43. #include <stdbool.h>
  44. #include <nuttx/sched.h>
  45. /****************************************************************************
  46. * Pre-processor Definitions
  47. ****************************************************************************/
  48. /****************************************************************************
  49. * Public Type Definitions
  50. ****************************************************************************/
  51. /****************************************************************************
  52. * Public Data
  53. ****************************************************************************/
  54. /****************************************************************************
  55. * Public Function Prototypes
  56. ****************************************************************************/
  57. struct tcb_s; /* Forward reference */
  58. /* Task start-up */
  59. void nxtask_start(void);
  60. int nxtask_schedsetup(FAR struct task_tcb_s *tcb, int priority,
  61. start_t start, main_t main, uint8_t ttype);
  62. int nxtask_argsetup(FAR struct task_tcb_s *tcb, FAR const char *name,
  63. FAR char * const argv[]);
  64. /* Task exit */
  65. int nxtask_exit(void);
  66. int nxtask_terminate(pid_t pid, bool nonblocking);
  67. void nxtask_exithook(FAR struct tcb_s *tcb, int status, bool nonblocking);
  68. void nxtask_recover(FAR struct tcb_s *tcb);
  69. /* Cancellation points */
  70. #ifdef CONFIG_CANCELLATION_POINTS
  71. void nxnotify_cancellation(FAR struct tcb_s *tcb);
  72. #endif
  73. #endif /* __SCHED_TASK_TASK_H */